xref: /illumos-gate/usr/src/contrib/mDNSResponder/mDNSCore/mDNS.c (revision 8a2b682e57a046b828f37bcde1776f131ef4629f)
1 /* -*- Mode: C; tab-width: 4 -*-
2  *
3  * Copyright (c) 2002-2015 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_PurgeForQuestion(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         q->metrics = metrics;
552 #endif
553         if (sock)
554         {
555             // 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.
556             if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
557             else
558             {
559                 // Transplant the old socket into the new question, and copy the query ID across too.
560                 // No need to close the old q->LocalSocket value because it won't have been created yet (they're made lazily on-demand).
561                 q->LocalSocket = sock;
562                 q->TargetQID = id;
563             }
564         }
565     }
566 }
567 
568 #ifdef USE_LIBIDN
569 
570 #include <unicode/uidna.h>
571 
572 // #define DEBUG_PUNYCODE 1
573 
574 mDNSlocal mDNSu8 *PunycodeConvert(const mDNSu8 *const src, mDNSu8 *const dst, const mDNSu8 *const end)
575 {
576     UErrorCode errorCode = U_ZERO_ERROR;
577     UIDNAInfo info = UIDNA_INFO_INITIALIZER;
578     UIDNA *uts46 = uidna_openUTS46(UIDNA_USE_STD3_RULES|UIDNA_NONTRANSITIONAL_TO_UNICODE, &errorCode);
579     int32_t len = uidna_nameToASCII_UTF8(uts46, (const char *)src+1, src[0], (char *)dst+1, end-(dst+1), &info, &errorCode);
580     uidna_close(uts46);
581     #if DEBUG_PUNYCODE
582     if (errorCode) LogMsg("uidna_nameToASCII_UTF8(%##s) failed errorCode %d", src, errorCode);
583     if (info.errors) LogMsg("uidna_nameToASCII_UTF8(%##s) failed info.errors 0x%08X", src, info.errors);
584     if (len > MAX_DOMAIN_LABEL) LogMsg("uidna_nameToASCII_UTF8(%##s) result too long %d", src, len);
585     #endif
586     if (errorCode || info.errors || len > MAX_DOMAIN_LABEL) return mDNSNULL;
587     *dst = len;
588     return(dst + 1 + len);
589 }
590 
591 mDNSlocal mDNSBool IsHighASCIILabel(const mDNSu8 *d)
592 {
593     int i;
594     for (i=1; i<=d[0]; i++) if (d[i] & 0x80) return mDNStrue;
595     return mDNSfalse;
596 }
597 
598 mDNSlocal const mDNSu8 *FindLastHighASCIILabel(const domainname *const d)
599 {
600     const mDNSu8 *ptr = d->c;
601     const mDNSu8 *ans = mDNSNULL;
602     while (ptr[0])
603     {
604         const mDNSu8 *const next = ptr + 1 + ptr[0];
605         if (ptr[0] > MAX_DOMAIN_LABEL || next >= d->c + MAX_DOMAIN_NAME) return mDNSNULL;
606         if (IsHighASCIILabel(ptr)) ans = ptr;
607         ptr = next;
608     }
609     return ans;
610 }
611 
612 mDNSlocal mDNSBool PerformNextPunycodeConversion(const DNSQuestion *const q, domainname *const newname)
613 {
614     const mDNSu8 *h = FindLastHighASCIILabel(&q->qname);
615     #if DEBUG_PUNYCODE
616     LogMsg("PerformNextPunycodeConversion: %##s (%s) Last High-ASCII Label %##s", q->qname.c, DNSTypeName(q->qtype), h);
617     #endif
618     if (!h) return mDNSfalse;  // There are no high-ascii labels to convert
619 
620     mDNSu8 *const dst = PunycodeConvert(h, newname->c + (h - q->qname.c), newname->c + MAX_DOMAIN_NAME);
621     if (!dst)
622         return mDNSfalse;  // The label was not convertible to Punycode
623     else
624     {
625         // If Punycode conversion of final eligible label was successful, copy the rest of the domainname
626         const mDNSu8 *const src = h + 1 + h[0];
627         const mDNSu8 remainder  = DomainNameLength((domainname*)src);
628         if (dst + remainder > newname->c + MAX_DOMAIN_NAME) return mDNSfalse;  // Name too long -- cannot be converted to Punycode
629 
630         mDNSPlatformMemCopy(newname->c, q->qname.c, h - q->qname.c);  // Fill in the leading part
631         mDNSPlatformMemCopy(dst, src, remainder);                     // Fill in the trailing part
632         #if DEBUG_PUNYCODE
633         LogMsg("PerformNextPunycodeConversion: %##s converted to %##s", q->qname.c, newname->c);
634         #endif
635         return mDNStrue;
636     }
637 }
638 
639 #endif // USE_LIBIDN
640 
641 // For a single given DNSQuestion pointed to by CurrentQuestion, deliver an add/remove result for the single given AuthRecord
642 // Note: All the callers should use the m->CurrentQuestion to see if the question is still valid or not
643 mDNSlocal void AnswerLocalQuestionWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
644 {
645     DNSQuestion *q = m->CurrentQuestion;
646     mDNSBool followcname;
647 
648     if (!q)
649     {
650         LogMsg("AnswerLocalQuestionWithLocalAuthRecord: ERROR!! CurrentQuestion NULL while answering with %s", ARDisplayString(m, rr));
651         return;
652     }
653 
654     followcname = FollowCNAME(q, &rr->resrec, AddRecord);
655 
656     // We should not be delivering results for record types Unregistered, Deregistering, and (unverified) Unique
657     if (!(rr->resrec.RecordType & kDNSRecordTypeActiveMask))
658     {
659         LogMsg("AnswerLocalQuestionWithLocalAuthRecord: *NOT* delivering %s event for local record type %X %s",
660                AddRecord ? "Add" : "Rmv", rr->resrec.RecordType, ARDisplayString(m, rr));
661         return;
662     }
663 
664     // Indicate that we've given at least one positive answer for this record, so we should be prepared to send a goodbye for it
665     if (AddRecord) rr->AnsweredLocalQ = mDNStrue;
666     mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
667     if (q->QuestionCallback && !q->NoAnswer)
668     {
669         q->CurrentAnswers += AddRecord ? 1 : -1;
670         if (UniqueLocalOnlyRecord(rr))
671         {
672             if (!followcname || q->ReturnIntermed)
673             {
674                 // Don't send this packet on the wire as we answered from /etc/hosts
675                 q->ThisQInterval = 0;
676                 q->LOAddressAnswers += AddRecord ? 1 : -1;
677                 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
678             }
679             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
680             // The callback above could have caused the question to stop. Detect that
681             // using m->CurrentQuestion
682             if (followcname && m->CurrentQuestion == q)
683                 AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
684             return;
685         }
686         else
687         {
688             q->QuestionCallback(m, q, &rr->resrec, AddRecord);
689         }
690     }
691     mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
692 }
693 
694 mDNSlocal void AnswerInterfaceAnyQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
695 {
696     if (m->CurrentQuestion)
697         LogMsg("AnswerInterfaceAnyQuestionsWithLocalAuthRecord: ERROR m->CurrentQuestion already set: %##s (%s)",
698                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
699     m->CurrentQuestion = m->Questions;
700     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
701     {
702         mDNSBool answered;
703         DNSQuestion *q = m->CurrentQuestion;
704         if (RRAny(rr))
705             answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
706         else
707             answered = LocalOnlyRecordAnswersQuestion(rr, q);
708         if (answered)
709             AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord);       // MUST NOT dereference q again
710         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
711             m->CurrentQuestion = q->next;
712     }
713     m->CurrentQuestion = mDNSNULL;
714 }
715 
716 // When a new local AuthRecord is created or deleted, AnswerAllLocalQuestionsWithLocalAuthRecord()
717 // delivers the appropriate add/remove events to listening questions:
718 // 1. It runs though all our LocalOnlyQuestions delivering answers as appropriate,
719 //    stopping if it reaches a NewLocalOnlyQuestion -- brand-new questions are handled by AnswerNewLocalOnlyQuestion().
720 // 2. If the AuthRecord is marked mDNSInterface_LocalOnly or mDNSInterface_P2P, then it also runs though
721 //    our main question list, delivering answers to mDNSInterface_Any questions as appropriate,
722 //    stopping if it reaches a NewQuestion -- brand-new questions are handled by AnswerNewQuestion().
723 //
724 // AnswerAllLocalQuestionsWithLocalAuthRecord is used by the m->NewLocalRecords loop in mDNS_Execute(),
725 // and by mDNS_Deregister_internal()
726 
727 mDNSlocal void AnswerAllLocalQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
728 {
729     if (m->CurrentQuestion)
730         LogMsg("AnswerAllLocalQuestionsWithLocalAuthRecord ERROR m->CurrentQuestion already set: %##s (%s)",
731                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
732 
733     m->CurrentQuestion = m->LocalOnlyQuestions;
734     while (m->CurrentQuestion && m->CurrentQuestion != m->NewLocalOnlyQuestions)
735     {
736         mDNSBool answered;
737         DNSQuestion *q = m->CurrentQuestion;
738         // We are called with both LocalOnly/P2P record or a regular AuthRecord
739         if (RRAny(rr))
740             answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
741         else
742             answered = LocalOnlyRecordAnswersQuestion(rr, q);
743         if (answered)
744             AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord);           // MUST NOT dereference q again
745         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
746             m->CurrentQuestion = q->next;
747     }
748 
749     m->CurrentQuestion = mDNSNULL;
750 
751     // If this AuthRecord is marked LocalOnly or P2P, then we want to deliver it to all local 'mDNSInterface_Any' questions
752     if (rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P)
753         AnswerInterfaceAnyQuestionsWithLocalAuthRecord(m, rr, AddRecord);
754 
755 }
756 
757 // ***************************************************************************
758 #if COMPILER_LIKES_PRAGMA_MARK
759 #pragma mark -
760 #pragma mark - Resource Record Utility Functions
761 #endif
762 
763 #define RRTypeIsAddressType(T) ((T) == kDNSType_A || (T) == kDNSType_AAAA)
764 
765 #define ResourceRecordIsValidAnswer(RR) ( ((RR)->resrec.RecordType & kDNSRecordTypeActiveMask)  && \
766                                           ((RR)->Additional1 == mDNSNULL || ((RR)->Additional1->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
767                                           ((RR)->Additional2 == mDNSNULL || ((RR)->Additional2->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
768                                           ((RR)->DependentOn == mDNSNULL || ((RR)->DependentOn->resrec.RecordType & kDNSRecordTypeActiveMask))  )
769 
770 #define ResourceRecordIsValidInterfaceAnswer(RR, INTID) \
771     (ResourceRecordIsValidAnswer(RR) && \
772      ((RR)->resrec.InterfaceID == mDNSInterface_Any || (RR)->resrec.InterfaceID == (INTID)))
773 
774 #define DefaultProbeCountForTypeUnique ((mDNSu8)3)
775 #define DefaultProbeCountForRecordType(X)      ((X) == kDNSRecordTypeUnique ? DefaultProbeCountForTypeUnique : (mDNSu8)0)
776 
777 // See RFC 6762: "8.3 Announcing"
778 // "The Multicast DNS responder MUST send at least two unsolicited responses, one second apart."
779 // Send 4, which is really 8 since we send on both IPv4 and IPv6.
780 #define InitialAnnounceCount ((mDNSu8)4)
781 
782 // For goodbye packets we set the count to 3, and for wakeups we set it to 18
783 // (which will be up to 15 wakeup attempts over the course of 30 seconds,
784 // and then if the machine fails to wake, 3 goodbye packets).
785 #define GoodbyeCount ((mDNSu8)3)
786 #define WakeupCount ((mDNSu8)18)
787 #define MAX_PROBE_RESTARTS ((mDNSu8)20)
788 
789 // Number of wakeups we send if WakeOnResolve is set in the question
790 #define InitialWakeOnResolveCount ((mDNSu8)3)
791 
792 // Note that the announce intervals use exponential backoff, doubling each time. The probe intervals do not.
793 // This means that because the announce interval is doubled after sending the first packet, the first
794 // observed on-the-wire inter-packet interval between announcements is actually one second.
795 // The half-second value here may be thought of as a conceptual (non-existent) half-second delay *before* the first packet is sent.
796 #define DefaultProbeIntervalForTypeUnique (mDNSPlatformOneSecond/4)
797 #define DefaultAnnounceIntervalForTypeShared (mDNSPlatformOneSecond/2)
798 #define DefaultAnnounceIntervalForTypeUnique (mDNSPlatformOneSecond/2)
799 
800 #define DefaultAPIntervalForRecordType(X)  ((X) &kDNSRecordTypeActiveSharedMask ? DefaultAnnounceIntervalForTypeShared : \
801                                             (X) &kDNSRecordTypeUnique           ? DefaultProbeIntervalForTypeUnique    : \
802                                             (X) &kDNSRecordTypeActiveUniqueMask ? DefaultAnnounceIntervalForTypeUnique : 0)
803 
804 #define TimeToAnnounceThisRecord(RR,time) ((RR)->AnnounceCount && (time) - ((RR)->LastAPTime + (RR)->ThisAPInterval) >= 0)
805 #define TicksTTL(RR) ((mDNSs32)(RR)->resrec.rroriginalttl * mDNSPlatformOneSecond)
806 #define RRExpireTime(RR) ((RR)->TimeRcvd + TicksTTL(RR))
807 
808 // Adjustment factor to avoid race condition (used for unicast cache entries) :
809 // 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.
810 // If we do our normal refresh at 80% of the TTL, our local caching server will return 20 seconds, so we'll do another
811 // 80% refresh after 16 seconds, and then the server will return 4 seconds, and so on, in the fashion of Zeno's paradox.
812 // To avoid this, we extend the record's effective TTL to give it a little extra grace period.
813 // We adjust the 100 second TTL to 127. This means that when we do our 80% query at 102 seconds,
814 // the cached copy at our local caching server will already have expired, so the server will be forced
815 // to fetch a fresh copy from the authoritative server, and then return a fresh record with the full TTL of 3600 seconds.
816 
817 #define RRAdjustTTL(ttl) ((ttl) + ((ttl)/4) + 2)
818 #define RRUnadjustedTTL(ttl) ((((ttl) - 2) * 4) / 5)
819 
820 #define MaxUnansweredQueries 4
821 
822 // SameResourceRecordSignature returns true if two resources records have the same name, type, and class, and may be sent
823 // (or were received) on the same interface (i.e. if *both* records specify an interface, then it has to match).
824 // TTL and rdata may differ.
825 // This is used for cache flush management:
826 // When sending a unique record, all other records matching "SameResourceRecordSignature" must also be sent
827 // When receiving a unique record, all old cache records matching "SameResourceRecordSignature" are flushed
828 
829 // SameResourceRecordNameClassInterface is functionally the same as SameResourceRecordSignature, except rrtype does not have to match
830 
831 #define SameResourceRecordSignature(A,B) (A)->resrec.rrtype == (B)->resrec.rrtype && SameResourceRecordNameClassInterface((A),(B))
832 
833 mDNSlocal mDNSBool SameResourceRecordNameClassInterface(const AuthRecord *const r1, const AuthRecord *const r2)
834 {
835     if (!r1) { LogMsg("SameResourceRecordSignature ERROR: r1 is NULL"); return(mDNSfalse); }
836     if (!r2) { LogMsg("SameResourceRecordSignature ERROR: r2 is NULL"); return(mDNSfalse); }
837     if (r1->resrec.InterfaceID &&
838         r2->resrec.InterfaceID &&
839         r1->resrec.InterfaceID != r2->resrec.InterfaceID) return(mDNSfalse);
840     return (mDNSBool)(
841                r1->resrec.rrclass  == r2->resrec.rrclass &&
842                r1->resrec.namehash == r2->resrec.namehash &&
843                SameDomainName(r1->resrec.name, r2->resrec.name));
844 }
845 
846 // PacketRRMatchesSignature behaves as SameResourceRecordSignature, except that types may differ if our
847 // authoratative record is unique (as opposed to shared). For unique records, we are supposed to have
848 // complete ownership of *all* types for this name, so *any* record type with the same name is a conflict.
849 // In addition, when probing we send our questions with the wildcard type kDNSQType_ANY,
850 // so a response of any type should match, even if it is not actually the type the client plans to use.
851 
852 // For now, to make it easier to avoid false conflicts, we treat SPS Proxy records like shared records,
853 // and require the rrtypes to match for the rdata to be considered potentially conflicting
854 mDNSlocal mDNSBool PacketRRMatchesSignature(const CacheRecord *const pktrr, const AuthRecord *const authrr)
855 {
856     if (!pktrr)  { LogMsg("PacketRRMatchesSignature ERROR: pktrr is NULL"); return(mDNSfalse); }
857     if (!authrr) { LogMsg("PacketRRMatchesSignature ERROR: authrr is NULL"); return(mDNSfalse); }
858     if (pktrr->resrec.InterfaceID &&
859         authrr->resrec.InterfaceID &&
860         pktrr->resrec.InterfaceID != authrr->resrec.InterfaceID) return(mDNSfalse);
861     if (!(authrr->resrec.RecordType & kDNSRecordTypeUniqueMask) || authrr->WakeUp.HMAC.l[0])
862         if (pktrr->resrec.rrtype != authrr->resrec.rrtype) return(mDNSfalse);
863     if ((authrr->resrec.InterfaceID == mDNSInterface_Any) &&
864         !mDNSPlatformValidRecordForInterface(authrr, pktrr->resrec.InterfaceID)) return(mDNSfalse);
865     return (mDNSBool)(
866                pktrr->resrec.rrclass == authrr->resrec.rrclass &&
867                pktrr->resrec.namehash == authrr->resrec.namehash &&
868                SameDomainName(pktrr->resrec.name, authrr->resrec.name));
869 }
870 
871 // CacheRecord *ka is the CacheRecord from the known answer list in the query.
872 // This is the information that the requester believes to be correct.
873 // AuthRecord *rr is the answer we are proposing to give, if not suppressed.
874 // This is the information that we believe to be correct.
875 // We've already determined that we plan to give this answer on this interface
876 // (either the record is non-specific, or it is specific to this interface)
877 // so now we just need to check the name, type, class, rdata and TTL.
878 mDNSlocal mDNSBool ShouldSuppressKnownAnswer(const CacheRecord *const ka, const AuthRecord *const rr)
879 {
880     // If RR signature is different, or data is different, then don't suppress our answer
881     if (!IdenticalResourceRecord(&ka->resrec, &rr->resrec)) return(mDNSfalse);
882 
883     // If the requester's indicated TTL is less than half the real TTL,
884     // we need to give our answer before the requester's copy expires.
885     // If the requester's indicated TTL is at least half the real TTL,
886     // then we can suppress our answer this time.
887     // If the requester's indicated TTL is greater than the TTL we believe,
888     // then that's okay, and we don't need to do anything about it.
889     // (If two responders on the network are offering the same information,
890     // that's okay, and if they are offering the information with different TTLs,
891     // the one offering the lower TTL should defer to the one offering the higher TTL.)
892     return (mDNSBool)(ka->resrec.rroriginalttl >= rr->resrec.rroriginalttl / 2);
893 }
894 
895 mDNSlocal void SetNextAnnounceProbeTime(mDNS *const m, const AuthRecord *const rr)
896 {
897     if (rr->resrec.RecordType == kDNSRecordTypeUnique)
898     {
899         if ((rr->LastAPTime + rr->ThisAPInterval) - m->timenow > mDNSPlatformOneSecond * 10)
900         {
901             LogMsg("SetNextAnnounceProbeTime: ProbeCount %d Next in %d %s", rr->ProbeCount, (rr->LastAPTime + rr->ThisAPInterval) - m->timenow, ARDisplayString(m, rr));
902             LogMsg("SetNextAnnounceProbeTime: m->SuppressProbes %d m->timenow %d diff %d", m->SuppressProbes, m->timenow, m->SuppressProbes - m->timenow);
903         }
904         if (m->NextScheduledProbe - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
905             m->NextScheduledProbe = (rr->LastAPTime + rr->ThisAPInterval);
906         // Some defensive code:
907         // If (rr->LastAPTime + rr->ThisAPInterval) happens to be far in the past, we don't want to allow
908         // NextScheduledProbe to be set excessively in the past, because that can cause bad things to happen.
909         // See: <rdar://problem/7795434> mDNS: Sometimes advertising stops working and record interval is set to zero
910         if (m->NextScheduledProbe - m->timenow < 0)
911             m->NextScheduledProbe = m->timenow;
912     }
913     else if (rr->AnnounceCount && (ResourceRecordIsValidAnswer(rr) || rr->resrec.RecordType == kDNSRecordTypeDeregistering))
914     {
915         if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
916             m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
917     }
918 }
919 
920 mDNSlocal void InitializeLastAPTime(mDNS *const m, AuthRecord *const rr)
921 {
922     // For reverse-mapping Sleep Proxy PTR records, probe interval is one second
923     rr->ThisAPInterval = rr->AddressProxy.type ? mDNSPlatformOneSecond : DefaultAPIntervalForRecordType(rr->resrec.RecordType);
924 
925     // * If this is a record type that's going to probe, then we use the m->SuppressProbes time.
926     // * Otherwise, if it's not going to probe, but m->SuppressProbes is set because we have other
927     //   records that are going to probe, then we delay its first announcement so that it will
928     //   go out synchronized with the first announcement for the other records that *are* probing.
929     //   This is a minor performance tweak that helps keep groups of related records synchronized together.
930     //   The addition of "interval / 2" is to make sure that, in the event that any of the probes are
931     //   delayed by a few milliseconds, this announcement does not inadvertently go out *before* the probing is complete.
932     //   When the probing is complete and those records begin to announce, these records will also be picked up and accelerated,
933     //   because they will meet the criterion of being at least half-way to their scheduled announcement time.
934     // * If it's not going to probe and m->SuppressProbes is not already set then we should announce immediately.
935 
936     if (rr->ProbeCount)
937     {
938         // If we have no probe suppression time set, or it is in the past, set it now
939         if (m->SuppressProbes == 0 || m->SuppressProbes - m->timenow < 0)
940         {
941             // To allow us to aggregate probes when a group of services are registered together,
942             // the first probe is delayed by a random delay in the range 1/8 to 1/4 second.
943             // This means the common-case behaviour is:
944             // randomized wait; probe
945             // 1/4 second wait; probe
946             // 1/4 second wait; probe
947             // 1/4 second wait; announce (i.e. service is normally announced 7/8 to 1 second after being registered)
948             m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
949 
950             // If we already have a *probe* scheduled to go out sooner, then use that time to get better aggregation
951             if (m->SuppressProbes - m->NextScheduledProbe >= 0)
952                 m->SuppressProbes = NonZeroTime(m->NextScheduledProbe);
953             if (m->SuppressProbes - m->timenow < 0)     // Make sure we don't set m->SuppressProbes excessively in the past
954                 m->SuppressProbes = m->timenow;
955 
956             // If we already have a *query* scheduled to go out sooner, then use that time to get better aggregation
957             if (m->SuppressProbes - m->NextScheduledQuery >= 0)
958                 m->SuppressProbes = NonZeroTime(m->NextScheduledQuery);
959             if (m->SuppressProbes - m->timenow < 0)     // Make sure we don't set m->SuppressProbes excessively in the past
960                 m->SuppressProbes = m->timenow;
961 
962             // except... don't expect to be able to send before the m->SuppressSending timer fires
963             if (m->SuppressSending && m->SuppressProbes - m->SuppressSending < 0)
964                 m->SuppressProbes = NonZeroTime(m->SuppressSending);
965 
966             if (m->SuppressProbes - m->timenow > mDNSPlatformOneSecond * 8)
967             {
968                 LogMsg("InitializeLastAPTime ERROR m->SuppressProbes %d m->NextScheduledProbe %d m->NextScheduledQuery %d m->SuppressSending %d %d",
969                        m->SuppressProbes     - m->timenow,
970                        m->NextScheduledProbe - m->timenow,
971                        m->NextScheduledQuery - m->timenow,
972                        m->SuppressSending,
973                        m->SuppressSending    - m->timenow);
974                 m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
975             }
976         }
977         rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval;
978     }
979     // Skip kDNSRecordTypeKnownUnique and kDNSRecordTypeShared records here and set their LastAPTime in the "else" block below so
980     // that they get announced immediately, otherwise, their announcement would be delayed until the based on the SuppressProbes value.
981     else if ((rr->resrec.RecordType != kDNSRecordTypeKnownUnique) && (rr->resrec.RecordType != kDNSRecordTypeShared) && m->SuppressProbes && (m->SuppressProbes - m->timenow >= 0))
982         rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval + DefaultProbeIntervalForTypeUnique * DefaultProbeCountForTypeUnique + rr->ThisAPInterval / 2;
983     else
984         rr->LastAPTime = m->timenow - rr->ThisAPInterval;
985 
986     // For reverse-mapping Sleep Proxy PTR records we don't want to start probing instantly -- we
987     // wait one second to give the client a chance to go to sleep, and then start our ARP/NDP probing.
988     // After three probes one second apart with no answer, we conclude the client is now sleeping
989     // and we can begin broadcasting our announcements to take over ownership of that IP address.
990     // If we don't wait for the client to go to sleep, then when the client sees our ARP Announcements there's a risk
991     // (depending on the OS and networking stack it's using) that it might interpret it as a conflict and change its IP address.
992     if (rr->AddressProxy.type)
993         rr->LastAPTime = m->timenow;
994 
995     // Set LastMCTime to now, to inhibit multicast responses
996     // (no need to send additional multicast responses when we're announcing anyway)
997     rr->LastMCTime      = m->timenow;
998     rr->LastMCInterface = mDNSInterfaceMark;
999 
1000     SetNextAnnounceProbeTime(m, rr);
1001 }
1002 
1003 mDNSlocal const domainname *SetUnicastTargetToHostName(mDNS *const m, AuthRecord *rr)
1004 {
1005     const domainname *target;
1006     if (rr->AutoTarget)
1007     {
1008         // For autotunnel services pointing at our IPv6 ULA we don't need or want a NAT mapping, but for all other
1009         // advertised services referencing our uDNS hostname, we want NAT mappings automatically created as appropriate,
1010         // with the port number in our advertised SRV record automatically tracking the external mapped port.
1011         DomainAuthInfo *AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
1012         if (!AuthInfo || !AuthInfo->AutoTunnel) rr->AutoTarget = Target_AutoHostAndNATMAP;
1013     }
1014 
1015     target = GetServiceTarget(m, rr);
1016     if (!target || target->c[0] == 0)
1017     {
1018         // defer registration until we've got a target
1019         LogInfo("SetUnicastTargetToHostName No target for %s", ARDisplayString(m, rr));
1020         rr->state = regState_NoTarget;
1021         return mDNSNULL;
1022     }
1023     else
1024     {
1025         LogInfo("SetUnicastTargetToHostName target %##s for resource record %s", target->c, ARDisplayString(m,rr));
1026         return target;
1027     }
1028 }
1029 
1030 // Right now this only applies to mDNS (.local) services where the target host is always m->MulticastHostname
1031 // Eventually we should unify this with GetServiceTarget() in uDNS.c
1032 mDNSlocal void SetTargetToHostName(mDNS *const m, AuthRecord *const rr)
1033 {
1034     domainname *const target = GetRRDomainNameTarget(&rr->resrec);
1035     const domainname *newname = &m->MulticastHostname;
1036 
1037     if (!target) LogInfo("SetTargetToHostName: Don't know how to set the target of rrtype %s", DNSTypeName(rr->resrec.rrtype));
1038 
1039     if (!(rr->ForceMCast || rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P || IsLocalDomain(&rr->namestorage)))
1040     {
1041         const domainname *const n = SetUnicastTargetToHostName(m, rr);
1042         if (n) newname = n;
1043         else { if (target) target->c[0] = 0; SetNewRData(&rr->resrec, mDNSNULL, 0); return; }
1044     }
1045 
1046     if (target && SameDomainName(target, newname))
1047         debugf("SetTargetToHostName: Target of %##s is already %##s", rr->resrec.name->c, target->c);
1048 
1049     if (target && !SameDomainName(target, newname))
1050     {
1051         AssignDomainName(target, newname);
1052         SetNewRData(&rr->resrec, mDNSNULL, 0);      // Update rdlength, rdestimate, rdatahash
1053 
1054         // If we're in the middle of probing this record, we need to start again,
1055         // because changing its rdata may change the outcome of the tie-breaker.
1056         // (If the record type is kDNSRecordTypeUnique (unconfirmed unique) then DefaultProbeCountForRecordType is non-zero.)
1057         rr->ProbeCount     = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1058 
1059         // If we've announced this record, we really should send a goodbye packet for the old rdata before
1060         // changing to the new rdata. However, in practice, we only do SetTargetToHostName for unique records,
1061         // so when we announce them we'll set the kDNSClass_UniqueRRSet and clear any stale data that way.
1062         if (rr->RequireGoodbye && rr->resrec.RecordType == kDNSRecordTypeShared)
1063             debugf("Have announced shared record %##s (%s) at least once: should have sent a goodbye packet before updating",
1064                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1065 
1066         rr->AnnounceCount  = InitialAnnounceCount;
1067         rr->RequireGoodbye = mDNSfalse;
1068         rr->ProbeRestartCount = 0;
1069         InitializeLastAPTime(m, rr);
1070     }
1071 }
1072 
1073 mDNSlocal void AcknowledgeRecord(mDNS *const m, AuthRecord *const rr)
1074 {
1075     if (rr->RecordCallback)
1076     {
1077         // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1078         // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1079         rr->Acknowledged = mDNStrue;
1080         mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1081         rr->RecordCallback(m, rr, mStatus_NoError);
1082         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1083     }
1084 }
1085 
1086 mDNSexport void ActivateUnicastRegistration(mDNS *const m, AuthRecord *const rr)
1087 {
1088     // Make sure that we don't activate the SRV record and associated service records, if it is in
1089     // NoTarget state. First time when a service is being instantiated, SRV record may be in NoTarget state.
1090     // We should not activate any of the other reords (PTR, TXT) that are part of the service. When
1091     // the target becomes available, the records will be reregistered.
1092     if (rr->resrec.rrtype != kDNSType_SRV)
1093     {
1094         AuthRecord *srvRR = mDNSNULL;
1095         if (rr->resrec.rrtype == kDNSType_PTR)
1096             srvRR = rr->Additional1;
1097         else if (rr->resrec.rrtype == kDNSType_TXT)
1098             srvRR = rr->DependentOn;
1099         if (srvRR)
1100         {
1101             if (srvRR->resrec.rrtype != kDNSType_SRV)
1102             {
1103                 LogMsg("ActivateUnicastRegistration: ERROR!! Resource record %s wrong, expecting SRV type", ARDisplayString(m, srvRR));
1104             }
1105             else
1106             {
1107                 LogInfo("ActivateUnicastRegistration: Found Service Record %s in state %d for %##s (%s)",
1108                         ARDisplayString(m, srvRR), srvRR->state, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1109                 rr->state = srvRR->state;
1110             }
1111         }
1112     }
1113 
1114     if (rr->state == regState_NoTarget)
1115     {
1116         LogInfo("ActivateUnicastRegistration record %s in regState_NoTarget, not activating", ARDisplayString(m, rr));
1117         return;
1118     }
1119     // When we wake up from sleep, we call ActivateUnicastRegistration. It is possible that just before we went to sleep,
1120     // the service/record was being deregistered. In that case, we should not try to register again. For the cases where
1121     // the records are deregistered due to e.g., no target for the SRV record, we would have returned from above if it
1122     // was already in NoTarget state. If it was in the process of deregistration but did not complete fully before we went
1123     // 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.
1124     if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
1125     {
1126         LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to DeregPending", ARDisplayString(m, rr), rr->state);
1127         rr->state = regState_DeregPending;
1128     }
1129     else
1130     {
1131         LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to Pending", ARDisplayString(m, rr), rr->state);
1132         rr->state = regState_Pending;
1133     }
1134     rr->ProbeCount     = 0;
1135     rr->ProbeRestartCount = 0;
1136     rr->AnnounceCount  = 0;
1137     rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
1138     rr->LastAPTime     = m->timenow - rr->ThisAPInterval;
1139     rr->expire         = 0; // Forget about all the leases, start fresh
1140     rr->uselease       = mDNStrue;
1141     rr->updateid       = zeroID;
1142     rr->SRVChanged     = mDNSfalse;
1143     rr->updateError    = mStatus_NoError;
1144     // RestartRecordGetZoneData calls this function whenever a new interface gets registered with core.
1145     // The records might already be registered with the server and hence could have NAT state.
1146     if (rr->NATinfo.clientContext)
1147     {
1148         mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1149         rr->NATinfo.clientContext = mDNSNULL;
1150     }
1151     if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1152     if (rr->tcp) { DisposeTCPConn(rr->tcp);       rr->tcp = mDNSNULL; }
1153     if (m->NextuDNSEvent - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
1154         m->NextuDNSEvent = (rr->LastAPTime + rr->ThisAPInterval);
1155 }
1156 
1157 // Two records qualify to be local duplicates if:
1158 // (a) the RecordTypes are the same, or
1159 // (b) one is Unique and the other Verified
1160 // (c) either is in the process of deregistering
1161 #define RecordLDT(A,B) ((A)->resrec.RecordType == (B)->resrec.RecordType || \
1162                         ((A)->resrec.RecordType | (B)->resrec.RecordType) == (kDNSRecordTypeUnique | kDNSRecordTypeVerified) || \
1163                         ((A)->resrec.RecordType == kDNSRecordTypeDeregistering || (B)->resrec.RecordType == kDNSRecordTypeDeregistering))
1164 
1165 #define RecordIsLocalDuplicate(A,B) \
1166     ((A)->resrec.InterfaceID == (B)->resrec.InterfaceID && RecordLDT((A),(B)) && IdenticalResourceRecord(& (A)->resrec, & (B)->resrec))
1167 
1168 mDNSlocal AuthRecord *CheckAuthIdenticalRecord(AuthHash *r, AuthRecord *rr)
1169 {
1170     const AuthGroup *a;
1171     AuthRecord *rp;
1172 
1173     a = AuthGroupForRecord(r, &rr->resrec);
1174     if (!a) return mDNSNULL;
1175     rp = a->members;
1176     while (rp)
1177     {
1178         if (!RecordIsLocalDuplicate(rp, rr))
1179             rp = rp->next;
1180         else
1181         {
1182             if (rp->resrec.RecordType == kDNSRecordTypeDeregistering)
1183             {
1184                 rp->AnnounceCount = 0;
1185                 rp = rp->next;
1186             }
1187             else return rp;
1188         }
1189     }
1190     return (mDNSNULL);
1191 }
1192 
1193 mDNSlocal mDNSBool CheckAuthRecordConflict(AuthHash *r, AuthRecord *rr)
1194 {
1195     const AuthGroup *a;
1196     const AuthRecord *rp;
1197 
1198     a = AuthGroupForRecord(r, &rr->resrec);
1199     if (!a) return mDNSfalse;
1200     rp = a->members;
1201     while (rp)
1202     {
1203         const AuthRecord *s1 = rr->RRSet ? rr->RRSet : rr;
1204         const AuthRecord *s2 = rp->RRSet ? rp->RRSet : rp;
1205         if (s1 != s2 && SameResourceRecordSignature(rp, rr) && !IdenticalSameNameRecord(&rp->resrec, &rr->resrec))
1206             return mDNStrue;
1207         else
1208             rp = rp->next;
1209     }
1210     return (mDNSfalse);
1211 }
1212 
1213 // checks to see if "rr" is already present
1214 mDNSlocal AuthRecord *CheckAuthSameRecord(AuthHash *r, AuthRecord *rr)
1215 {
1216     const AuthGroup *a;
1217     AuthRecord *rp;
1218 
1219     a = AuthGroupForRecord(r, &rr->resrec);
1220     if (!a) return mDNSNULL;
1221     rp = a->members;
1222     while (rp)
1223     {
1224         if (rp != rr)
1225             rp = rp->next;
1226         else
1227         {
1228             return rp;
1229         }
1230     }
1231     return (mDNSNULL);
1232 }
1233 
1234 
1235 mDNSlocal void DecrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1236 {
1237     if (RRLocalOnly(rr))
1238     {
1239         // A sanity check, this should be prevented in calling code.
1240         LogInfo("DecrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1241         return;
1242     }
1243 
1244     if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1245     {
1246         // If about to get rid of the last advertised service
1247         if (m->AutoTargetServices == 1)
1248             DeadvertiseAllInterfaceRecords(m);
1249 
1250         m->AutoTargetServices--;
1251         LogInfo("DecrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1252     }
1253 
1254 #if BONJOUR_ON_DEMAND
1255     if (!AuthRecord_uDNS(rr))
1256     {
1257         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1258             m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
1259         m->NumAllInterfaceRecords--;
1260         LogInfo("DecrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1261             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1262     }
1263 #endif // BONJOUR_ON_DEMAND
1264 }
1265 
1266 mDNSlocal void IncrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1267 {
1268     mDNSBool enablingBonjour = 0;
1269 
1270     if (RRLocalOnly(rr))
1271     {
1272         // A sanity check, this should be prevented in calling code.
1273         LogInfo("IncrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1274         return;
1275     }
1276 
1277 #if BONJOUR_ON_DEMAND
1278     if (!AuthRecord_uDNS(rr))
1279     {
1280         m->NumAllInterfaceRecords++;
1281         LogInfo("IncrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1282             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1283         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1284         {
1285             m->NextBonjourDisableTime = 0;
1286             if (m->BonjourEnabled == 0)
1287             {
1288                 // Enable Bonjour immediately by scheduling network changed processing where
1289                 // we will join the multicast group on each active interface.
1290                 m->BonjourEnabled = 1;
1291                 enablingBonjour = 1;
1292                 m->NetworkChanged = m->timenow;
1293             }
1294         }
1295     }
1296 #endif // BONJOUR_ON_DEMAND
1297 
1298     if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1299     {
1300         m->AutoTargetServices++;
1301         LogInfo("IncrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1302 
1303         // If this is the first advertised service and we did not just enable Bonjour above, then
1304         // advertise all the interface records.  If we did enable Bonjour above, the interface records will
1305         // be advertised during the network changed processing scheduled above, so no need
1306         // to do it here.
1307         if ((m->AutoTargetServices == 1) && (enablingBonjour == 0))
1308             AdvertiseAllInterfaceRecords(m);
1309     }
1310 }
1311 
1312 mDNSlocal void getKeepaliveRaddr(mDNS *const m, AuthRecord *rr, mDNSAddr *raddr)
1313 {
1314     mDNSAddr     laddr = zeroAddr;
1315     mDNSEthAddr  eth = zeroEthAddr;
1316     mDNSIPPort   lport = zeroIPPort;
1317     mDNSIPPort   rport = zeroIPPort;
1318     mDNSu32      timeout = 0;
1319     mDNSu32      seq = 0;
1320     mDNSu32      ack = 0;
1321     mDNSu16      win = 0;
1322 
1323     if (mDNS_KeepaliveRecord(&rr->resrec))
1324     {
1325         mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, raddr, &eth, &seq, &ack, &lport, &rport, &win);
1326         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
1327         {
1328             LogMsg("getKeepaliveRaddr: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, raddr, rport.NotAnInteger);
1329             return;
1330         }
1331     }
1332 }
1333 
1334 // Exported so uDNS.c can call this
1335 mDNSexport mStatus mDNS_Register_internal(mDNS *const m, AuthRecord *const rr)
1336 {
1337     domainname *target = GetRRDomainNameTarget(&rr->resrec);
1338     AuthRecord *r;
1339     AuthRecord **p = &m->ResourceRecords;
1340     AuthRecord **d = &m->DuplicateRecords;
1341 
1342     if ((mDNSs32)rr->resrec.rroriginalttl <= 0)
1343     { LogMsg("mDNS_Register_internal: TTL %X should be 1 - 0x7FFFFFFF %s", rr->resrec.rroriginalttl, ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1344 
1345     if (!rr->resrec.RecordType)
1346     { LogMsg("mDNS_Register_internal: RecordType must be non-zero %s", ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1347 
1348     if (m->ShutdownTime)
1349     { LogMsg("mDNS_Register_internal: Shutting down, can't register %s", ARDisplayString(m, rr)); return(mStatus_ServiceNotRunning); }
1350 
1351     if (m->DivertMulticastAdvertisements && !AuthRecord_uDNS(rr))
1352     {
1353         mDNSInterfaceID previousID = rr->resrec.InterfaceID;
1354         if (rr->resrec.InterfaceID == mDNSInterface_Any || rr->resrec.InterfaceID == mDNSInterface_P2P)
1355         {
1356             rr->resrec.InterfaceID = mDNSInterface_LocalOnly;
1357             rr->ARType = AuthRecordLocalOnly;
1358         }
1359         if (rr->resrec.InterfaceID != mDNSInterface_LocalOnly)
1360         {
1361             NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
1362             if (intf && !intf->Advertise) { rr->resrec.InterfaceID = mDNSInterface_LocalOnly; rr->ARType = AuthRecordLocalOnly; }
1363         }
1364         if (rr->resrec.InterfaceID != previousID)
1365             LogInfo("mDNS_Register_internal: Diverting record to local-only %s", ARDisplayString(m, rr));
1366     }
1367 
1368     if (RRLocalOnly(rr))
1369     {
1370         if (CheckAuthSameRecord(&m->rrauth, rr))
1371         {
1372             LogMsg("mDNS_Register_internal: ERROR!! Tried to register LocalOnly AuthRecord %p %##s (%s) that's already in the list",
1373                    rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1374             return(mStatus_AlreadyRegistered);
1375         }
1376     }
1377     else
1378     {
1379         while (*p && *p != rr) p=&(*p)->next;
1380         if (*p)
1381         {
1382             LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the list",
1383                    rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1384             return(mStatus_AlreadyRegistered);
1385         }
1386     }
1387 
1388     while (*d && *d != rr) d=&(*d)->next;
1389     if (*d)
1390     {
1391         LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the Duplicate list",
1392                rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1393         return(mStatus_AlreadyRegistered);
1394     }
1395 
1396     if (rr->DependentOn)
1397     {
1398         if (rr->resrec.RecordType == kDNSRecordTypeUnique)
1399             rr->resrec.RecordType =  kDNSRecordTypeVerified;
1400         else if (rr->resrec.RecordType != kDNSRecordTypeKnownUnique)
1401         {
1402             LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn && RecordType != kDNSRecordTypeUnique or kDNSRecordTypeKnownUnique",
1403                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1404             return(mStatus_Invalid);
1405         }
1406         if (!(rr->DependentOn->resrec.RecordType & (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique)))
1407         {
1408             LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn->RecordType bad type %X",
1409                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->DependentOn->resrec.RecordType);
1410             return(mStatus_Invalid);
1411         }
1412     }
1413 
1414     rr->next = mDNSNULL;
1415 
1416     // Field Group 1: The actual information pertaining to this resource record
1417     // Set up by client prior to call
1418 
1419     // Field Group 2: Persistent metadata for Authoritative Records
1420 //  rr->Additional1       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1421 //  rr->Additional2       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1422 //  rr->DependentOn       = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1423 //  rr->RRSet             = set to mDNSNULL  in mDNS_SetupResourceRecord; may be overridden by client
1424 //  rr->Callback          = already set      in mDNS_SetupResourceRecord
1425 //  rr->Context           = already set      in mDNS_SetupResourceRecord
1426 //  rr->RecordType        = already set      in mDNS_SetupResourceRecord
1427 //  rr->HostTarget        = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1428 //  rr->AllowRemoteQuery  = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1429     // Make sure target is not uninitialized data, or we may crash writing debugging log messages
1430     if (rr->AutoTarget && target) target->c[0] = 0;
1431 
1432     // Field Group 3: Transient state for Authoritative Records
1433     rr->Acknowledged      = mDNSfalse;
1434     rr->ProbeCount        = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1435     rr->ProbeRestartCount = 0;
1436     rr->AnnounceCount     = InitialAnnounceCount;
1437     rr->RequireGoodbye    = mDNSfalse;
1438     rr->AnsweredLocalQ    = mDNSfalse;
1439     rr->IncludeInProbe    = mDNSfalse;
1440     rr->ImmedUnicast      = mDNSfalse;
1441     rr->SendNSECNow       = mDNSNULL;
1442     rr->ImmedAnswer       = mDNSNULL;
1443     rr->ImmedAdditional   = mDNSNULL;
1444     rr->SendRNow          = mDNSNULL;
1445     rr->v4Requester       = zerov4Addr;
1446     rr->v6Requester       = zerov6Addr;
1447     rr->NextResponse      = mDNSNULL;
1448     rr->NR_AnswerTo       = mDNSNULL;
1449     rr->NR_AdditionalTo   = mDNSNULL;
1450     if (!rr->AutoTarget) InitializeLastAPTime(m, rr);
1451 //  rr->LastAPTime        = Set for us in InitializeLastAPTime()
1452 //  rr->LastMCTime        = Set for us in InitializeLastAPTime()
1453 //  rr->LastMCInterface   = Set for us in InitializeLastAPTime()
1454     rr->NewRData          = mDNSNULL;
1455     rr->newrdlength       = 0;
1456     rr->UpdateCallback    = mDNSNULL;
1457     rr->UpdateCredits     = kMaxUpdateCredits;
1458     rr->NextUpdateCredit  = 0;
1459     rr->UpdateBlocked     = 0;
1460 
1461     // For records we're holding as proxy (except reverse-mapping PTR records) two announcements is sufficient
1462     if (rr->WakeUp.HMAC.l[0] && !rr->AddressProxy.type) rr->AnnounceCount = 2;
1463 
1464     // Field Group 4: Transient uDNS state for Authoritative Records
1465     rr->state             = regState_Zero;
1466     rr->uselease          = 0;
1467     rr->expire            = 0;
1468     rr->Private           = 0;
1469     rr->updateid          = zeroID;
1470     rr->updateIntID       = zeroOpaque64;
1471     rr->zone              = rr->resrec.name;
1472     rr->nta               = mDNSNULL;
1473     rr->tcp               = mDNSNULL;
1474     rr->OrigRData         = 0;
1475     rr->OrigRDLen         = 0;
1476     rr->InFlightRData     = 0;
1477     rr->InFlightRDLen     = 0;
1478     rr->QueuedRData       = 0;
1479     rr->QueuedRDLen       = 0;
1480     //mDNSPlatformMemZero(&rr->NATinfo, sizeof(rr->NATinfo));
1481     // We should be recording the actual internal port for this service record here. Once we initiate our NAT mapping
1482     // request we'll subsequently overwrite srv.port with the allocated external NAT port -- potentially multiple
1483     // times with different values if the external NAT port changes during the lifetime of the service registration.
1484     //if (rr->resrec.rrtype == kDNSType_SRV) rr->NATinfo.IntPort = rr->resrec.rdata->u.srv.port;
1485 
1486 //  rr->resrec.interface         = already set in mDNS_SetupResourceRecord
1487 //  rr->resrec.name->c           = MUST be set by client
1488 //  rr->resrec.rrtype            = already set in mDNS_SetupResourceRecord
1489 //  rr->resrec.rrclass           = already set in mDNS_SetupResourceRecord
1490 //  rr->resrec.rroriginalttl     = already set in mDNS_SetupResourceRecord
1491 //  rr->resrec.rdata             = MUST be set by client, unless record type is CNAME or PTR and rr->HostTarget is set
1492 
1493     // BIND named (name daemon) doesn't allow TXT records with zero-length rdata. This is strictly speaking correct,
1494     // since RFC 1035 specifies a TXT record as "One or more <character-string>s", not "Zero or more <character-string>s".
1495     // Since some legacy apps try to create zero-length TXT records, we'll silently correct it here.
1496     if (rr->resrec.rrtype == kDNSType_TXT && rr->resrec.rdlength == 0) { rr->resrec.rdlength = 1; rr->resrec.rdata->u.txt.c[0] = 0; }
1497 
1498     if (rr->AutoTarget)
1499     {
1500         SetTargetToHostName(m, rr); // Also sets rdlength and rdestimate for us, and calls InitializeLastAPTime();
1501 #ifndef UNICAST_DISABLED
1502         // If we have no target record yet, SetTargetToHostName will set rr->state == regState_NoTarget
1503         // 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.
1504         if (rr->state == regState_NoTarget)
1505         {
1506             // Initialize the target so that we don't crash while logging etc.
1507             domainname *tar = GetRRDomainNameTarget(&rr->resrec);
1508             if (tar) tar->c[0] = 0;
1509             LogInfo("mDNS_Register_internal: record %s in NoTarget state", ARDisplayString(m, rr));
1510         }
1511 #endif
1512     }
1513     else
1514     {
1515         rr->resrec.rdlength   = GetRDLength(&rr->resrec, mDNSfalse);
1516         rr->resrec.rdestimate = GetRDLength(&rr->resrec, mDNStrue);
1517     }
1518 
1519     if (!ValidateDomainName(rr->resrec.name))
1520     { LogMsg("Attempt to register record with invalid name: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1521 
1522     // Don't do this until *after* we've set rr->resrec.rdlength
1523     if (!ValidateRData(rr->resrec.rrtype, rr->resrec.rdlength, rr->resrec.rdata))
1524     { LogMsg("Attempt to register record with invalid rdata: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1525 
1526     rr->resrec.namehash   = DomainNameHashValue(rr->resrec.name);
1527     rr->resrec.rdatahash  = target ? DomainNameHashValue(target) : RDataHashValue(&rr->resrec);
1528 
1529     if (RRLocalOnly(rr))
1530     {
1531         // If this is supposed to be unique, make sure we don't have any name conflicts.
1532         // If we found a conflict, we may still want to insert the record in the list but mark it appropriately
1533         // (kDNSRecordTypeDeregistering) so that we deliver RMV events to the application. But this causes more
1534         // complications and not clear whether there are any benefits. See rdar:9304275 for details.
1535         // Hence, just bail out.
1536         // This comment is doesn’t make any sense. -- SC
1537         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
1538         {
1539             if (CheckAuthRecordConflict(&m->rrauth, rr))
1540             {
1541                 LogInfo("mDNS_Register_internal: Name conflict %s (%p), InterfaceID %p", ARDisplayString(m, rr), rr, rr->resrec.InterfaceID);
1542                 return mStatus_NameConflict;
1543             }
1544         }
1545     }
1546 
1547     // For uDNS records, we don't support duplicate checks at this time.
1548 #ifndef UNICAST_DISABLED
1549     if (AuthRecord_uDNS(rr))
1550     {
1551         if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1552         // When we called SetTargetToHostName, it may have caused mDNS_Register_internal to be re-entered, appending new
1553         // 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.
1554         // Note that for AutoTunnel this should never happen, but this check makes the code future-proof.
1555         while (*p) p=&(*p)->next;
1556         *p = rr;
1557         if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1558         rr->ProbeCount    = 0;
1559         rr->ProbeRestartCount = 0;
1560         rr->AnnounceCount = 0;
1561         if (rr->state != regState_NoTarget) ActivateUnicastRegistration(m, rr);
1562         return(mStatus_NoError);            // <--- Note: For unicast records, code currently bails out at this point
1563     }
1564 #endif
1565 
1566     // Now that we've finished building our new record, make sure it's not identical to one we already have
1567     if (RRLocalOnly(rr))
1568     {
1569         rr->ProbeCount    = 0;
1570         rr->ProbeRestartCount = 0;
1571         rr->AnnounceCount = 0;
1572         r = CheckAuthIdenticalRecord(&m->rrauth, rr);
1573     }
1574     else
1575     {
1576         for (r = m->ResourceRecords; r; r=r->next)
1577             if (RecordIsLocalDuplicate(r, rr))
1578             {
1579                 if (r->resrec.RecordType == kDNSRecordTypeDeregistering) r->AnnounceCount = 0;
1580                 else break;
1581             }
1582     }
1583 
1584     if (r)
1585     {
1586         LogInfo("mDNS_Register_internal: Adding to duplicate list %s", ARDisplayString(m,rr));
1587         *d = rr;
1588         // If the previous copy of this record is already verified unique,
1589         // then indicate that we should move this record promptly to kDNSRecordTypeUnique state.
1590         // Setting ProbeCount to zero will cause SendQueries() to advance this record to
1591         // kDNSRecordTypeVerified state and call the client callback at the next appropriate time.
1592         if (rr->resrec.RecordType == kDNSRecordTypeUnique && r->resrec.RecordType == kDNSRecordTypeVerified)
1593             rr->ProbeCount = 0;
1594     }
1595     else
1596     {
1597         LogInfo("mDNS_Register_internal: Adding to active record list %s", ARDisplayString(m,rr));
1598         if (RRLocalOnly(rr))
1599         {
1600             AuthGroup *ag;
1601             ag = InsertAuthRecord(m, &m->rrauth, rr);
1602             if (ag && !ag->NewLocalOnlyRecords)
1603             {
1604                 m->NewLocalOnlyRecords = mDNStrue;
1605                 ag->NewLocalOnlyRecords = rr;
1606             }
1607             // No probing for LocalOnly records; acknowledge them right away
1608             if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1609             AcknowledgeRecord(m, rr);
1610             return(mStatus_NoError);
1611         }
1612         else
1613         {
1614             if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1615             *p = rr;
1616         }
1617     }
1618 
1619     if (!AuthRecord_uDNS(rr))   // This check is superfluous, given that for unicast records we (currently) bail out above
1620     {
1621         // We have inserted the record in the list. See if we have to advertise the A/AAAA, HINFO, PTR records.
1622         IncrementAutoTargetServices(m, rr);
1623 
1624         // For records that are not going to probe, acknowledge them right away
1625         if (rr->resrec.RecordType != kDNSRecordTypeUnique && rr->resrec.RecordType != kDNSRecordTypeDeregistering)
1626             AcknowledgeRecord(m, rr);
1627 
1628         // Adding a record may affect whether or not we should sleep
1629         mDNS_UpdateAllowSleep(m);
1630     }
1631 
1632     // If this is a non-sleep proxy keepalive record, fetch the MAC address of the remote host.
1633     // This is used by the in-NIC proxy to send the keepalive packets.
1634     if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
1635     {
1636         mDNSAddr raddr;
1637         // Set the record type to known unique to prevent probing keep alive records.
1638         // Also make sure we do not announce the keepalive records.
1639        rr->resrec.RecordType = kDNSRecordTypeKnownUnique;
1640        rr->AnnounceCount     = 0;
1641        getKeepaliveRaddr(m, rr, &raddr);
1642        // This is an asynchronous call. Once the remote MAC address is available, helper will schedule an
1643        // asynchronous task to update the resource record
1644        mDNSPlatformGetRemoteMacAddr(&raddr);
1645     }
1646 
1647     return(mStatus_NoError);
1648 }
1649 
1650 mDNSlocal void RecordProbeFailure(mDNS *const m, const AuthRecord *const rr)
1651 {
1652     m->ProbeFailTime = m->timenow;
1653     m->NumFailedProbes++;
1654     // If we've had fifteen or more probe failures, rate-limit to one every five seconds.
1655     // If a bunch of hosts have all been configured with the same name, then they'll all
1656     // conflict and run through the same series of names: name-2, name-3, name-4, etc.,
1657     // up to name-10. After that they'll start adding random increments in the range 1-100,
1658     // so they're more likely to branch out in the available namespace and settle on a set of
1659     // unique names quickly. If after five more tries the host is still conflicting, then we
1660     // may have a serious problem, so we start rate-limiting so we don't melt down the network.
1661     if (m->NumFailedProbes >= 15)
1662     {
1663         m->SuppressProbes = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
1664         LogMsg("Excessive name conflicts (%lu) for %##s (%s); rate limiting in effect",
1665                m->NumFailedProbes, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1666     }
1667 }
1668 
1669 mDNSlocal void CompleteRDataUpdate(mDNS *const m, AuthRecord *const rr)
1670 {
1671     RData *OldRData = rr->resrec.rdata;
1672     mDNSu16 OldRDLen = rr->resrec.rdlength;
1673     SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);    // Update our rdata
1674     rr->NewRData = mDNSNULL;                                    // Clear the NewRData pointer ...
1675     if (rr->UpdateCallback)
1676         rr->UpdateCallback(m, rr, OldRData, OldRDLen);          // ... and let the client know
1677 }
1678 
1679 // Note: mDNS_Deregister_internal can call a user callback, which may change the record list and/or question list.
1680 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
1681 // Exported so uDNS.c can call this
1682 mDNSexport mStatus mDNS_Deregister_internal(mDNS *const m, AuthRecord *const rr, mDNS_Dereg_type drt)
1683 {
1684     AuthRecord *r2;
1685     mDNSu8 RecordType = rr->resrec.RecordType;
1686     AuthRecord **p = &m->ResourceRecords;   // Find this record in our list of active records
1687     mDNSBool dupList = mDNSfalse;
1688 
1689     if (RRLocalOnly(rr))
1690     {
1691         AuthGroup *a;
1692         AuthRecord **rp;
1693 
1694         a = AuthGroupForRecord(&m->rrauth, &rr->resrec);
1695         if (!a) return mDNSfalse;
1696         rp = &a->members;
1697         while (*rp && *rp != rr) rp=&(*rp)->next;
1698         p = rp;
1699     }
1700     else
1701     {
1702         while (*p && *p != rr) p=&(*p)->next;
1703     }
1704 
1705     if (*p)
1706     {
1707         // We found our record on the main list. See if there are any duplicates that need special handling.
1708         if (drt == mDNS_Dereg_conflict)     // If this was a conflict, see that all duplicates get the same treatment
1709         {
1710             // Scan for duplicates of rr, and mark them for deregistration at the end of this routine, after we've finished
1711             // deregistering rr. We need to do this scan *before* we give the client the chance to free and reuse the rr memory.
1712             for (r2 = m->DuplicateRecords; r2; r2=r2->next) if (RecordIsLocalDuplicate(r2, rr)) r2->ProbeCount = 0xFF;
1713         }
1714         else
1715         {
1716             // Before we delete the record (and potentially send a goodbye packet)
1717             // first see if we have a record on the duplicate list ready to take over from it.
1718             AuthRecord **d = &m->DuplicateRecords;
1719             while (*d && !RecordIsLocalDuplicate(*d, rr)) d=&(*d)->next;
1720             if (*d)
1721             {
1722                 AuthRecord *dup = *d;
1723                 debugf("mDNS_Register_internal: Duplicate record %p taking over from %p %##s (%s)",
1724                        dup, rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1725                 *d        = dup->next;      // Cut replacement record from DuplicateRecords list
1726                 if (RRLocalOnly(rr))
1727                 {
1728                     dup->next = mDNSNULL;
1729                     if (!InsertAuthRecord(m, &m->rrauth, dup)) LogMsg("mDNS_Deregister_internal: ERROR!! cannot insert %s", ARDisplayString(m, dup));
1730                 }
1731                 else
1732                 {
1733                     dup->next = rr->next;       // And then...
1734                     rr->next  = dup;            // ... splice it in right after the record we're about to delete
1735                 }
1736                 dup->resrec.RecordType        = rr->resrec.RecordType;
1737                 dup->ProbeCount      = rr->ProbeCount;
1738                 dup->ProbeRestartCount = rr->ProbeRestartCount;
1739                 dup->AnnounceCount   = rr->AnnounceCount;
1740                 dup->RequireGoodbye  = rr->RequireGoodbye;
1741                 dup->AnsweredLocalQ  = rr->AnsweredLocalQ;
1742                 dup->ImmedAnswer     = rr->ImmedAnswer;
1743                 dup->ImmedUnicast    = rr->ImmedUnicast;
1744                 dup->ImmedAdditional = rr->ImmedAdditional;
1745                 dup->v4Requester     = rr->v4Requester;
1746                 dup->v6Requester     = rr->v6Requester;
1747                 dup->ThisAPInterval  = rr->ThisAPInterval;
1748                 dup->LastAPTime      = rr->LastAPTime;
1749                 dup->LastMCTime      = rr->LastMCTime;
1750                 dup->LastMCInterface = rr->LastMCInterface;
1751                 dup->Private         = rr->Private;
1752                 dup->state           = rr->state;
1753                 rr->RequireGoodbye = mDNSfalse;
1754                 rr->AnsweredLocalQ = mDNSfalse;
1755             }
1756         }
1757     }
1758     else
1759     {
1760         // We didn't find our record on the main list; try the DuplicateRecords list instead.
1761         p = &m->DuplicateRecords;
1762         while (*p && *p != rr) p=&(*p)->next;
1763         // If we found our record on the duplicate list, then make sure we don't send a goodbye for it
1764         if (*p)
1765         {
1766             // Duplicate records are not used for sending wakeups or goodbyes. Hence, deregister them
1767             // immediately. When there is a conflict, we deregister all the conflicting duplicate records
1768             // also that have been marked above in this function. In that case, we come here and if we don't
1769             // deregister (unilink from the DuplicateRecords list), we will be recursing infinitely. Hence,
1770             // clear the HMAC which will cause it to deregister. See <rdar://problem/10380988> for
1771             // details.
1772             rr->WakeUp.HMAC    = zeroEthAddr;
1773             rr->RequireGoodbye = mDNSfalse;
1774             rr->resrec.RecordType = kDNSRecordTypeDeregistering;
1775             dupList = mDNStrue;
1776         }
1777         if (*p) debugf("mDNS_Deregister_internal: Deleting DuplicateRecord %p %##s (%s)",
1778                        rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1779     }
1780 
1781     if (!*p)
1782     {
1783         // No need to log an error message if we already know this is a potentially repeated deregistration
1784         if (drt != mDNS_Dereg_repeat)
1785             LogMsg("mDNS_Deregister_internal: Record %p not found in list %s", rr, ARDisplayString(m,rr));
1786         return(mStatus_BadReferenceErr);
1787     }
1788 
1789     // If this is a shared record and we've announced it at least once,
1790     // we need to retract that announcement before we delete the record
1791 
1792     // If this is a record (including mDNSInterface_LocalOnly records) for which we've given local-only answers then
1793     // it's tempting to just do "AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse)" here, but that would not not be safe.
1794     // The AnswerAllLocalQuestionsWithLocalAuthRecord routine walks the question list invoking client callbacks, using the "m->CurrentQuestion"
1795     // mechanism to cope with the client callback modifying the question list while that's happening.
1796     // However, mDNS_Deregister could have been called from a client callback (e.g. from the domain enumeration callback FoundDomain)
1797     // which means that the "m->CurrentQuestion" mechanism is already in use to protect that list, so we can't use it twice.
1798     // More generally, if we invoke callbacks from within a client callback, then those callbacks could deregister other
1799     // records, thereby invoking yet more callbacks, without limit.
1800     // The solution is to defer delivering the "Remove" events until mDNS_Execute time, just like we do for sending
1801     // actual goodbye packets.
1802 
1803 #ifndef UNICAST_DISABLED
1804     if (AuthRecord_uDNS(rr))
1805     {
1806         if (rr->RequireGoodbye)
1807         {
1808             if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
1809             rr->resrec.RecordType    = kDNSRecordTypeDeregistering;
1810             m->LocalRemoveEvents     = mDNStrue;
1811             uDNS_DeregisterRecord(m, rr);
1812             // At this point unconditionally we bail out
1813             // Either uDNS_DeregisterRecord will have completed synchronously, and called CompleteDeregistration,
1814             // which calls us back here with RequireGoodbye set to false, or it will have initiated the deregistration
1815             // process and will complete asynchronously. Either way we don't need to do anything more here.
1816             return(mStatus_NoError);
1817         }
1818         // Sometimes the records don't complete proper deregistration i.e., don't wait for a response
1819         // from the server. In that case, if the records have been part of a group update, clear the
1820         // state here. Some recors e.g., AutoTunnel gets reused without ever being completely initialized
1821         rr->updateid = zeroID;
1822 
1823         // We defer cleaning up NAT state only after sending goodbyes. This is important because
1824         // RecordRegistrationGotZoneData guards against creating NAT state if clientContext is non-NULL.
1825         // This happens today when we turn on/off interface where we get multiple network transitions
1826         // and RestartRecordGetZoneData triggers re-registration of the resource records even though
1827         // they may be in Registered state which causes NAT information to be setup multiple times. Defering
1828         // the cleanup here keeps clientContext non-NULL and hence prevents that. Note that cleaning up
1829         // NAT state here takes care of the case where we did not send goodbyes at all.
1830         if (rr->NATinfo.clientContext)
1831         {
1832             mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1833             rr->NATinfo.clientContext = mDNSNULL;
1834         }
1835         if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1836         if (rr->tcp) { DisposeTCPConn(rr->tcp);       rr->tcp = mDNSNULL; }
1837     }
1838 #endif // UNICAST_DISABLED
1839 
1840     if      (RecordType == kDNSRecordTypeUnregistered)
1841         LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeUnregistered", ARDisplayString(m, rr));
1842     else if (RecordType == kDNSRecordTypeDeregistering)
1843     {
1844         LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeDeregistering", ARDisplayString(m, rr));
1845         return(mStatus_BadReferenceErr);
1846     }
1847 
1848     // <rdar://problem/7457925> Local-only questions don't get remove events for unique records
1849     // We may want to consider changing this code so that we generate local-only question "rmv"
1850     // events (and maybe goodbye packets too) for unique records as well as for shared records
1851     // Note: If we change the logic for this "if" statement, need to ensure that the code in
1852     // CompleteDeregistration() sets the appropriate state variables to gaurantee that "else"
1853     // clause will execute here and the record will be cut from the list.
1854     if (rr->WakeUp.HMAC.l[0] ||
1855         (RecordType == kDNSRecordTypeShared && (rr->RequireGoodbye || rr->AnsweredLocalQ)))
1856     {
1857         verbosedebugf("mDNS_Deregister_internal: Starting deregistration for %s", ARDisplayString(m, rr));
1858         rr->resrec.RecordType    = kDNSRecordTypeDeregistering;
1859         rr->resrec.rroriginalttl = 0;
1860         rr->AnnounceCount        = rr->WakeUp.HMAC.l[0] ? WakeupCount : (drt == mDNS_Dereg_rapid) ? 1 : GoodbyeCount;
1861         rr->ThisAPInterval       = mDNSPlatformOneSecond * 2;
1862         rr->LastAPTime           = m->timenow - rr->ThisAPInterval;
1863         m->LocalRemoveEvents     = mDNStrue;
1864         if (m->NextScheduledResponse - (m->timenow + mDNSPlatformOneSecond/10) >= 0)
1865             m->NextScheduledResponse = (m->timenow + mDNSPlatformOneSecond/10);
1866     }
1867     else
1868     {
1869         if (!dupList && RRLocalOnly(rr))
1870         {
1871             AuthGroup *ag = RemoveAuthRecord(m, &m->rrauth, rr);
1872             if (ag->NewLocalOnlyRecords == rr) ag->NewLocalOnlyRecords = rr->next;
1873         }
1874         else
1875         {
1876             *p = rr->next;                  // Cut this record from the list
1877             if (m->NewLocalRecords == rr) m->NewLocalRecords = rr->next;
1878             DecrementAutoTargetServices(m, rr);
1879         }
1880         // If someone is about to look at this, bump the pointer forward
1881         if (m->CurrentRecord   == rr) m->CurrentRecord   = rr->next;
1882         rr->next = mDNSNULL;
1883 
1884         // Should we generate local remove events here?
1885         // i.e. something like:
1886         // if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse); rr->AnsweredLocalQ = mDNSfalse; }
1887 
1888         verbosedebugf("mDNS_Deregister_internal: Deleting record for %s", ARDisplayString(m, rr));
1889         rr->resrec.RecordType = kDNSRecordTypeUnregistered;
1890 
1891         if ((drt == mDNS_Dereg_conflict || drt == mDNS_Dereg_repeat) && RecordType == kDNSRecordTypeShared)
1892             debugf("mDNS_Deregister_internal: Cannot have a conflict on a shared record! %##s (%s)",
1893                    rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1894 
1895         // If we have an update queued up which never executed, give the client a chance to free that memory
1896         if (rr->NewRData) CompleteRDataUpdate(m, rr);   // Update our rdata, clear the NewRData pointer, and return memory to the client
1897 
1898 
1899         // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1900         // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1901         // In this case the likely client action to the mStatus_MemFree message is to free the memory,
1902         // so any attempt to touch rr after this is likely to lead to a crash.
1903         if (drt != mDNS_Dereg_conflict)
1904         {
1905             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1906             LogInfo("mDNS_Deregister_internal: callback with mStatus_MemFree for %s", ARDisplayString(m, rr));
1907             if (rr->RecordCallback)
1908                 rr->RecordCallback(m, rr, mStatus_MemFree);         // MUST NOT touch rr after this
1909             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1910         }
1911         else
1912         {
1913             RecordProbeFailure(m, rr);
1914             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
1915             if (rr->RecordCallback)
1916                 rr->RecordCallback(m, rr, mStatus_NameConflict);    // MUST NOT touch rr after this
1917             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
1918             // Now that we've finished deregistering rr, check our DuplicateRecords list for any that we marked previously.
1919             // Note that with all the client callbacks going on, by the time we get here all the
1920             // records we marked may have been explicitly deregistered by the client anyway.
1921             r2 = m->DuplicateRecords;
1922             while (r2)
1923             {
1924                 if (r2->ProbeCount != 0xFF)
1925                 {
1926                     r2 = r2->next;
1927                 }
1928                 else
1929                 {
1930 #if APPLE_OSX_mDNSResponder
1931                     // See if this record was also registered with any D2D plugins.
1932                     D2D_stop_advertising_record(r2);
1933 #endif
1934                     mDNS_Deregister_internal(m, r2, mDNS_Dereg_conflict);
1935                     // As this is a duplicate record, it will be unlinked from the list
1936                     // immediately
1937                     r2 = m->DuplicateRecords;
1938                 }
1939             }
1940         }
1941     }
1942     mDNS_UpdateAllowSleep(m);
1943     return(mStatus_NoError);
1944 }
1945 
1946 // ***************************************************************************
1947 #if COMPILER_LIKES_PRAGMA_MARK
1948 #pragma mark -
1949 #pragma mark - Packet Sending Functions
1950 #endif
1951 
1952 mDNSlocal void AddRecordToResponseList(AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *add)
1953 {
1954     if (rr->NextResponse == mDNSNULL && *nrpp != &rr->NextResponse)
1955     {
1956         **nrpp = rr;
1957         // NR_AdditionalTo must point to a record with NR_AnswerTo set (and not NR_AdditionalTo)
1958         // If 'add' does not meet this requirement, then follow its NR_AdditionalTo pointer to a record that does
1959         // The referenced record will definitely be acceptable (by recursive application of this rule)
1960         if (add && add->NR_AdditionalTo) add = add->NR_AdditionalTo;
1961         rr->NR_AdditionalTo = add;
1962         *nrpp = &rr->NextResponse;
1963     }
1964     debugf("AddRecordToResponseList: %##s (%s) already in list", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1965 }
1966 
1967 mDNSlocal void AddRRSetAdditionalsToResponseList(mDNS *const m, AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *additional, const mDNSInterfaceID InterfaceID)
1968 {
1969     AuthRecord *rr2;
1970     if (additional->resrec.RecordType & kDNSRecordTypeUniqueMask)
1971     {
1972         for (rr2 = m->ResourceRecords; rr2; rr2 = rr2->next)
1973         {
1974             if ((rr2->resrec.namehash == additional->resrec.namehash) &&
1975                 (rr2->resrec.rrtype   == additional->resrec.rrtype) &&
1976                 (rr2 != additional) &&
1977                 (rr2->resrec.RecordType & kDNSRecordTypeUniqueMask) &&
1978                 (rr2->resrec.rrclass  == additional->resrec.rrclass) &&
1979                 ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&
1980                 SameDomainName(rr2->resrec.name, additional->resrec.name))
1981             {
1982                 AddRecordToResponseList(nrpp, rr2, rr);
1983             }
1984         }
1985     }
1986 }
1987 
1988 mDNSlocal void AddAdditionalsToResponseList(mDNS *const m, AuthRecord *ResponseRecords, AuthRecord ***nrpp, const mDNSInterfaceID InterfaceID)
1989 {
1990     AuthRecord  *rr, *rr2;
1991     for (rr=ResponseRecords; rr; rr=rr->NextResponse)           // For each record we plan to put
1992     {
1993         // (Note: This is an "if", not a "while". If we add a record, we'll find it again
1994         // later in the "for" loop, and we will follow further "additional" links then.)
1995         if (rr->Additional1 && ResourceRecordIsValidInterfaceAnswer(rr->Additional1, InterfaceID))
1996         {
1997             AddRecordToResponseList(nrpp, rr->Additional1, rr);
1998             AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional1, InterfaceID);
1999         }
2000 
2001         if (rr->Additional2 && ResourceRecordIsValidInterfaceAnswer(rr->Additional2, InterfaceID))
2002         {
2003             AddRecordToResponseList(nrpp, rr->Additional2, rr);
2004             AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional2, InterfaceID);
2005         }
2006 
2007         // For SRV records, automatically add the Address record(s) for the target host
2008         if (rr->resrec.rrtype == kDNSType_SRV)
2009         {
2010             for (rr2=m->ResourceRecords; rr2; rr2=rr2->next)                    // Scan list of resource records
2011                 if (RRTypeIsAddressType(rr2->resrec.rrtype) &&                  // For all address records (A/AAAA) ...
2012                     ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&   // ... which are valid for answer ...
2013                     rr->resrec.rdatahash == rr2->resrec.namehash &&         // ... whose name is the name of the SRV target
2014                     SameDomainName(&rr->resrec.rdata->u.srv.target, rr2->resrec.name))
2015                     AddRecordToResponseList(nrpp, rr2, rr);
2016         }
2017         else if (RRTypeIsAddressType(rr->resrec.rrtype))    // For A or AAAA, put counterpart as additional
2018         {
2019             for (rr2=m->ResourceRecords; rr2; rr2=rr2->next)                    // Scan list of resource records
2020                 if (RRTypeIsAddressType(rr2->resrec.rrtype) &&                  // For all address records (A/AAAA) ...
2021                     ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&   // ... which are valid for answer ...
2022                     rr->resrec.namehash == rr2->resrec.namehash &&              // ... and have the same name
2023                     SameDomainName(rr->resrec.name, rr2->resrec.name))
2024                     AddRecordToResponseList(nrpp, rr2, rr);
2025         }
2026         else if (rr->resrec.rrtype == kDNSType_PTR)         // For service PTR, see if we want to add DeviceInfo record
2027         {
2028             if (ResourceRecordIsValidInterfaceAnswer(&m->DeviceInfo, InterfaceID) &&
2029                 SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2030                 AddRecordToResponseList(nrpp, &m->DeviceInfo, rr);
2031         }
2032     }
2033 }
2034 
2035 mDNSlocal int AnonInfoSpace(AnonymousInfo *info)
2036 {
2037     ResourceRecord *rr = info->nsec3RR;
2038 
2039     // 2 bytes for compressed name + type (2) class (2) TTL (4) rdlength (2) rdata (n)
2040     return (2 + 10 + rr->rdlength);
2041 }
2042 
2043 mDNSlocal void SendDelayedUnicastResponse(mDNS *const m, const mDNSAddr *const dest, const mDNSInterfaceID InterfaceID)
2044 {
2045     AuthRecord *rr;
2046     AuthRecord  *ResponseRecords = mDNSNULL;
2047     AuthRecord **nrp             = &ResponseRecords;
2048     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
2049     int AnoninfoSpace = 0;
2050 
2051     // Make a list of all our records that need to be unicast to this destination
2052     for (rr = m->ResourceRecords; rr; rr=rr->next)
2053     {
2054         // If we find we can no longer unicast this answer, clear ImmedUnicast
2055         if (rr->ImmedAnswer == mDNSInterfaceMark               ||
2056             mDNSSameIPv4Address(rr->v4Requester, onesIPv4Addr) ||
2057             mDNSSameIPv6Address(rr->v6Requester, onesIPv6Addr)  )
2058             rr->ImmedUnicast = mDNSfalse;
2059 
2060         if (rr->ImmedUnicast && rr->ImmedAnswer == InterfaceID)
2061         {
2062             if ((dest->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->v4Requester, dest->ip.v4)) ||
2063                 (dest->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->v6Requester, dest->ip.v6)))
2064             {
2065                 rr->ImmedAnswer  = mDNSNULL;                // Clear the state fields
2066                 rr->ImmedUnicast = mDNSfalse;
2067                 rr->v4Requester  = zerov4Addr;
2068                 rr->v6Requester  = zerov6Addr;
2069 
2070                 // Only sent records registered for P2P over P2P interfaces
2071                 if (intf && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID))
2072                 {
2073                     continue;
2074                 }
2075 
2076                 if (rr->NextResponse == mDNSNULL && nrp != &rr->NextResponse)   // rr->NR_AnswerTo
2077                 {
2078                     rr->NR_AnswerTo = NR_AnswerMulticast;
2079                     *nrp = rr;
2080                     nrp = &rr->NextResponse;
2081                 }
2082             }
2083         }
2084     }
2085 
2086     AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
2087 
2088     while (ResponseRecords)
2089     {
2090         mDNSu8 *responseptr = m->omsg.data;
2091         mDNSu8 *newptr;
2092         InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2093 
2094         // Put answers in the packet
2095         while (ResponseRecords && ResponseRecords->NR_AnswerTo)
2096         {
2097             rr = ResponseRecords;
2098             if (rr->resrec.AnonInfo)
2099             {
2100                 AnoninfoSpace += AnonInfoSpace(rr->resrec.AnonInfo);
2101                 rr->resrec.AnonInfo->SendNow = mDNSInterfaceMark;
2102             }
2103             if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2104                 rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2105 
2106             // Retract the limit by AnoninfoSpace which we need to put the AnoInfo option.
2107             newptr = PutResourceRecordTTLWithLimit(&m->omsg, responseptr, &m->omsg.h.numAnswers, &rr->resrec, rr->resrec.rroriginalttl,
2108                  m->omsg.data + (AllowedRRSpace(&m->omsg) - AnoninfoSpace));
2109 
2110             rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2111             if (!newptr && m->omsg.h.numAnswers)
2112             {
2113                 break; // If packet full, send it now
2114             }
2115             if (newptr) responseptr = newptr;
2116             ResponseRecords = rr->NextResponse;
2117             rr->NextResponse    = mDNSNULL;
2118             rr->NR_AnswerTo     = mDNSNULL;
2119             rr->NR_AdditionalTo = mDNSNULL;
2120             rr->RequireGoodbye  = mDNStrue;
2121         }
2122 
2123         // We have reserved the space for AnonInfo option. PutResourceRecord uses the
2124         // standard limit (AllowedRRSpace) and we should have space now.
2125         for (rr = m->ResourceRecords; rr; rr=rr->next)
2126         {
2127             if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == mDNSInterfaceMark)
2128             {
2129                 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2130 
2131                 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAuthorities, nsec3RR);
2132                 if (newptr)
2133                 {
2134                     responseptr = newptr;
2135                     debugf("SendDelayedUnicastResponse: Added NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2136                 }
2137                 else
2138                 {
2139                     // We allocated space and we should not fail. Don't break, we need to clear the SendNow flag.
2140                     LogMsg("SendDelayedUnicastResponse: ERROR!! Cannot Add NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2141                 }
2142                 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2143             }
2144         }
2145 
2146         // Add additionals, if there's space
2147         while (ResponseRecords && !ResponseRecords->NR_AnswerTo)
2148         {
2149             rr = ResponseRecords;
2150             if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2151                 rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2152             newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &rr->resrec);
2153             rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2154 
2155             if (newptr) responseptr = newptr;
2156             if (newptr && m->omsg.h.numAnswers) rr->RequireGoodbye = mDNStrue;
2157             else if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask) rr->ImmedAnswer = mDNSInterfaceMark;
2158             ResponseRecords = rr->NextResponse;
2159             rr->NextResponse    = mDNSNULL;
2160             rr->NR_AnswerTo     = mDNSNULL;
2161             rr->NR_AdditionalTo = mDNSNULL;
2162         }
2163 
2164         if (m->omsg.h.numAnswers)
2165             mDNSSendDNSMessage(m, &m->omsg, responseptr, InterfaceID, mDNSNULL, dest, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2166     }
2167 }
2168 
2169 // CompleteDeregistration guarantees that on exit the record will have been cut from the m->ResourceRecords list
2170 // and the client's mStatus_MemFree callback will have been invoked
2171 mDNSexport void CompleteDeregistration(mDNS *const m, AuthRecord *rr)
2172 {
2173     LogInfo("CompleteDeregistration: called for Resource record %s", ARDisplayString(m, rr));
2174     // Clearing rr->RequireGoodbye signals mDNS_Deregister_internal() that
2175     // it should go ahead and immediately dispose of this registration
2176     rr->resrec.RecordType = kDNSRecordTypeShared;
2177     rr->RequireGoodbye    = mDNSfalse;
2178     rr->WakeUp.HMAC       = zeroEthAddr;
2179     if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse); rr->AnsweredLocalQ = mDNSfalse; }
2180     mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);     // Don't touch rr after this
2181 }
2182 
2183 // DiscardDeregistrations is used on shutdown and sleep to discard (forcibly and immediately)
2184 // any deregistering records that remain in the m->ResourceRecords list.
2185 // DiscardDeregistrations calls mDNS_Deregister_internal which can call a user callback,
2186 // which may change the record list and/or question list.
2187 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2188 mDNSlocal void DiscardDeregistrations(mDNS *const m)
2189 {
2190     if (m->CurrentRecord)
2191         LogMsg("DiscardDeregistrations ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
2192     m->CurrentRecord = m->ResourceRecords;
2193 
2194     while (m->CurrentRecord)
2195     {
2196         AuthRecord *rr = m->CurrentRecord;
2197         if (!AuthRecord_uDNS(rr) && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2198             CompleteDeregistration(m, rr);      // Don't touch rr after this
2199         else
2200             m->CurrentRecord = rr->next;
2201     }
2202 }
2203 
2204 mDNSlocal mStatus GetLabelDecimalValue(const mDNSu8 *const src, mDNSu8 *dst)
2205 {
2206     int i, val = 0;
2207     if (src[0] < 1 || src[0] > 3) return(mStatus_Invalid);
2208     for (i=1; i<=src[0]; i++)
2209     {
2210         if (src[i] < '0' || src[i] > '9') return(mStatus_Invalid);
2211         val = val * 10 + src[i] - '0';
2212     }
2213     if (val > 255) return(mStatus_Invalid);
2214     *dst = (mDNSu8)val;
2215     return(mStatus_NoError);
2216 }
2217 
2218 mDNSlocal mStatus GetIPv4FromName(mDNSAddr *const a, const domainname *const name)
2219 {
2220     int skip = CountLabels(name) - 6;
2221     if (skip < 0) { LogMsg("GetIPFromName: Need six labels in IPv4 reverse mapping name %##s", name); return mStatus_Invalid; }
2222     if (GetLabelDecimalValue(SkipLeadingLabels(name, skip+3)->c, &a->ip.v4.b[0]) ||
2223         GetLabelDecimalValue(SkipLeadingLabels(name, skip+2)->c, &a->ip.v4.b[1]) ||
2224         GetLabelDecimalValue(SkipLeadingLabels(name, skip+1)->c, &a->ip.v4.b[2]) ||
2225         GetLabelDecimalValue(SkipLeadingLabels(name, skip+0)->c, &a->ip.v4.b[3])) return mStatus_Invalid;
2226     a->type = mDNSAddrType_IPv4;
2227     return(mStatus_NoError);
2228 }
2229 
2230 #define HexVal(X) ( ((X) >= '0' && (X) <= '9') ? ((X) - '0'     ) :   \
2231                     ((X) >= 'A' && (X) <= 'F') ? ((X) - 'A' + 10) :   \
2232                     ((X) >= 'a' && (X) <= 'f') ? ((X) - 'a' + 10) : -1)
2233 
2234 mDNSlocal mStatus GetIPv6FromName(mDNSAddr *const a, const domainname *const name)
2235 {
2236     int i, h, l;
2237     const domainname *n;
2238 
2239     int skip = CountLabels(name) - 34;
2240     if (skip < 0) { LogMsg("GetIPFromName: Need 34 labels in IPv6 reverse mapping name %##s", name); return mStatus_Invalid; }
2241 
2242     n = SkipLeadingLabels(name, skip);
2243     for (i=0; i<16; i++)
2244     {
2245         if (n->c[0] != 1) return mStatus_Invalid;
2246         l = HexVal(n->c[1]);
2247         n = (const domainname *)(n->c + 2);
2248 
2249         if (n->c[0] != 1) return mStatus_Invalid;
2250         h = HexVal(n->c[1]);
2251         n = (const domainname *)(n->c + 2);
2252 
2253         if (l<0 || h<0) return mStatus_Invalid;
2254         a->ip.v6.b[15-i] = (mDNSu8)((h << 4) | l);
2255     }
2256 
2257     a->type = mDNSAddrType_IPv6;
2258     return(mStatus_NoError);
2259 }
2260 
2261 mDNSlocal mDNSs32 ReverseMapDomainType(const domainname *const name)
2262 {
2263     int skip = CountLabels(name) - 2;
2264     if (skip >= 0)
2265     {
2266         const domainname *suffix = SkipLeadingLabels(name, skip);
2267         if (SameDomainName(suffix, (const domainname*)"\x7" "in-addr" "\x4" "arpa")) return mDNSAddrType_IPv4;
2268         if (SameDomainName(suffix, (const domainname*)"\x3" "ip6"     "\x4" "arpa")) return mDNSAddrType_IPv6;
2269     }
2270     return(mDNSAddrType_None);
2271 }
2272 
2273 mDNSlocal void SendARP(mDNS *const m, const mDNSu8 op, const AuthRecord *const rr,
2274                        const mDNSv4Addr *const spa, const mDNSEthAddr *const tha, const mDNSv4Addr *const tpa, const mDNSEthAddr *const dst)
2275 {
2276     int i;
2277     mDNSu8 *ptr = m->omsg.data;
2278     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2279     if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2280 
2281     // 0x00 Destination address
2282     for (i=0; i<6; i++) *ptr++ = dst->b[i];
2283 
2284     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2285     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
2286 
2287     // 0x0C ARP Ethertype (0x0806)
2288     *ptr++ = 0x08; *ptr++ = 0x06;
2289 
2290     // 0x0E ARP header
2291     *ptr++ = 0x00; *ptr++ = 0x01;   // Hardware address space; Ethernet = 1
2292     *ptr++ = 0x08; *ptr++ = 0x00;   // Protocol address space; IP = 0x0800
2293     *ptr++ = 6;                     // Hardware address length
2294     *ptr++ = 4;                     // Protocol address length
2295     *ptr++ = 0x00; *ptr++ = op;     // opcode; Request = 1, Response = 2
2296 
2297     // 0x16 Sender hardware address (our MAC address)
2298     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[i];
2299 
2300     // 0x1C Sender protocol address
2301     for (i=0; i<4; i++) *ptr++ = spa->b[i];
2302 
2303     // 0x20 Target hardware address
2304     for (i=0; i<6; i++) *ptr++ = tha->b[i];
2305 
2306     // 0x26 Target protocol address
2307     for (i=0; i<4; i++) *ptr++ = tpa->b[i];
2308 
2309     // 0x2A Total ARP Packet length 42 bytes
2310     mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2311 }
2312 
2313 mDNSlocal mDNSu16 CheckSum(const void *const data, mDNSs32 length, mDNSu32 sum)
2314 {
2315     const mDNSu16 *ptr = data;
2316     while (length > 0) { length -= 2; sum += *ptr++; }
2317     sum = (sum & 0xFFFF) + (sum >> 16);
2318     sum = (sum & 0xFFFF) + (sum >> 16);
2319     return(sum != 0xFFFF ? sum : 0);
2320 }
2321 
2322 mDNSlocal mDNSu16 IPv6CheckSum(const mDNSv6Addr *const src, const mDNSv6Addr *const dst, const mDNSu8 protocol, const void *const data, const mDNSu32 length)
2323 {
2324     IPv6PseudoHeader ph;
2325     ph.src = *src;
2326     ph.dst = *dst;
2327     ph.len.b[0] = length >> 24;
2328     ph.len.b[1] = length >> 16;
2329     ph.len.b[2] = length >> 8;
2330     ph.len.b[3] = length;
2331     ph.pro.b[0] = 0;
2332     ph.pro.b[1] = 0;
2333     ph.pro.b[2] = 0;
2334     ph.pro.b[3] = protocol;
2335     return CheckSum(&ph, sizeof(ph), CheckSum(data, length, 0));
2336 }
2337 
2338 mDNSlocal void SendNDP(mDNS *const m, const mDNSu8 op, const mDNSu8 flags, const AuthRecord *const rr,
2339                        const mDNSv6Addr *const spa, const mDNSEthAddr *const tha, const mDNSv6Addr *const tpa, const mDNSEthAddr *const dst)
2340 {
2341     int i;
2342     mDNSOpaque16 checksum;
2343     mDNSu8 *ptr = m->omsg.data;
2344     // Some recipient hosts seem to ignore Neighbor Solicitations if the IPv6-layer destination address is not the
2345     // appropriate IPv6 solicited node multicast address, so we use that IPv6-layer destination address, even though
2346     // at the Ethernet-layer we unicast the packet to the intended target, to avoid wasting network bandwidth.
2347     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] } };
2348     const mDNSv6Addr *const v6dst = (op == NDP_Sol) ? &mc : tpa;
2349     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2350     if (!intf) { LogMsg("SendNDP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2351 
2352     // 0x00 Destination address
2353     for (i=0; i<6; i++) *ptr++ = dst->b[i];
2354     // Right now we only send Neighbor Solicitations to verify whether the host we're proxying for has gone to sleep yet.
2355     // Since we know who we're looking for, we send it via Ethernet-layer unicast, rather than bothering every host on the
2356     // link with a pointless link-layer multicast.
2357     // Should we want to send traditional Neighbor Solicitations in the future, where we really don't know in advance what
2358     // Ethernet-layer address we're looking for, we'll need to send to the appropriate Ethernet-layer multicast address:
2359     // *ptr++ = 0x33;
2360     // *ptr++ = 0x33;
2361     // *ptr++ = 0xFF;
2362     // *ptr++ = tpa->b[0xD];
2363     // *ptr++ = tpa->b[0xE];
2364     // *ptr++ = tpa->b[0xF];
2365 
2366     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2367     for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2368 
2369     // 0x0C IPv6 Ethertype (0x86DD)
2370     *ptr++ = 0x86; *ptr++ = 0xDD;
2371 
2372     // 0x0E IPv6 header
2373     *ptr++ = 0x60; *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00;     // Version, Traffic Class, Flow Label
2374     *ptr++ = 0x00; *ptr++ = 0x20;                                   // Length
2375     *ptr++ = 0x3A;                                                  // Protocol == ICMPv6
2376     *ptr++ = 0xFF;                                                  // Hop Limit
2377 
2378     // 0x16 Sender IPv6 address
2379     for (i=0; i<16; i++) *ptr++ = spa->b[i];
2380 
2381     // 0x26 Destination IPv6 address
2382     for (i=0; i<16; i++) *ptr++ = v6dst->b[i];
2383 
2384     // 0x36 NDP header
2385     *ptr++ = op;                    // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement
2386     *ptr++ = 0x00;                  // Code
2387     *ptr++ = 0x00; *ptr++ = 0x00;   // Checksum placeholder (0x38, 0x39)
2388     *ptr++ = flags;
2389     *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00;
2390 
2391     if (op == NDP_Sol)  // Neighbor Solicitation. The NDP "target" is the address we seek.
2392     {
2393         // 0x3E NDP target.
2394         for (i=0; i<16; i++) *ptr++ = tpa->b[i];
2395         // 0x4E Source Link-layer Address
2396         // <http://www.ietf.org/rfc/rfc2461.txt>
2397         // MUST NOT be included when the source IP address is the unspecified address.
2398         // Otherwise, on link layers that have addresses this option MUST be included
2399         // in multicast solicitations and SHOULD be included in unicast solicitations.
2400         if (!mDNSIPv6AddressIsZero(*spa))
2401         {
2402             *ptr++ = NDP_SrcLL; // Option Type 1 == Source Link-layer Address
2403             *ptr++ = 0x01;      // Option length 1 (in units of 8 octets)
2404             for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2405         }
2406     }
2407     else            // Neighbor Advertisement. The NDP "target" is the address we're giving information about.
2408     {
2409         // 0x3E NDP target.
2410         for (i=0; i<16; i++) *ptr++ = spa->b[i];
2411         // 0x4E Target Link-layer Address
2412         *ptr++ = NDP_TgtLL; // Option Type 2 == Target Link-layer Address
2413         *ptr++ = 0x01;      // Option length 1 (in units of 8 octets)
2414         for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2415     }
2416 
2417     // 0x4E or 0x56 Total NDP Packet length 78 or 86 bytes
2418     m->omsg.data[0x13] = ptr - &m->omsg.data[0x36];     // Compute actual length
2419     checksum.NotAnInteger = ~IPv6CheckSum(spa, v6dst, 0x3A, &m->omsg.data[0x36], m->omsg.data[0x13]);
2420     m->omsg.data[0x38] = checksum.b[0];
2421     m->omsg.data[0x39] = checksum.b[1];
2422 
2423     mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2424 }
2425 
2426 mDNSlocal void SetupTracerOpt(const mDNS *const m, rdataOPT *const Trace)
2427 {
2428     mDNSu32 DNS_VERS = _DNS_SD_H;
2429     Trace->u.tracer.platf    = m->mDNS_plat;
2430     Trace->u.tracer.mDNSv    = DNS_VERS;
2431 
2432     Trace->opt              = kDNSOpt_Trace;
2433     Trace->optlen           = DNSOpt_TraceData_Space - 4;
2434 }
2435 
2436 mDNSlocal void SetupOwnerOpt(const mDNS *const m, const NetworkInterfaceInfo *const intf, rdataOPT *const owner)
2437 {
2438     owner->u.owner.vers     = 0;
2439     owner->u.owner.seq      = m->SleepSeqNum;
2440     owner->u.owner.HMAC     = m->PrimaryMAC;
2441     owner->u.owner.IMAC     = intf->MAC;
2442     owner->u.owner.password = zeroEthAddr;
2443 
2444     // Don't try to compute the optlen until *after* we've set up the data fields
2445     // 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
2446     owner->opt              = kDNSOpt_Owner;
2447     owner->optlen           = DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) - 4;
2448 }
2449 
2450 mDNSlocal void GrantUpdateCredit(AuthRecord *rr)
2451 {
2452     if (++rr->UpdateCredits >= kMaxUpdateCredits) rr->NextUpdateCredit = 0;
2453     else rr->NextUpdateCredit = NonZeroTime(rr->NextUpdateCredit + kUpdateCreditRefreshInterval);
2454 }
2455 
2456 mDNSlocal mDNSBool ShouldSendGoodbyesBeforeSleep(mDNS *const m, const NetworkInterfaceInfo *intf, AuthRecord *rr)
2457 {
2458     // If there are no sleep proxies, we set the state to SleepState_Sleeping explicitly
2459     // and hence there is no need to check for Transfering state. But if we have sleep
2460     // proxies and partially sending goodbyes for some records, we will be in Transfering
2461     // state and hence need to make sure that we send goodbyes in that case too. Checking whether
2462     // we are not awake handles both cases.
2463     if ((rr->AuthFlags & AuthFlagsWakeOnly) && (m->SleepState != SleepState_Awake))
2464     {
2465         debugf("ShouldSendGoodbyesBeforeSleep: marking for goodbye", ARDisplayString(m, rr));
2466         return mDNStrue;
2467     }
2468 
2469     if (m->SleepState != SleepState_Sleeping)
2470         return mDNSfalse;
2471 
2472     // If we are going to sleep and in SleepState_Sleeping, SendGoodbyes on the interface tell you
2473     // whether you can send goodbyes or not.
2474     if (!intf->SendGoodbyes)
2475     {
2476         debugf("ShouldSendGoodbyesBeforeSleep: not sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2477         return mDNSfalse;
2478     }
2479     else
2480     {
2481         debugf("ShouldSendGoodbyesBeforeSleep: sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2482         return mDNStrue;
2483     }
2484 }
2485 
2486 mDNSlocal mDNSBool IsInterfaceValidForAuthRecord(const AuthRecord *ar, mDNSInterfaceID InterfaceID)
2487 {
2488     mDNSBool result;
2489 
2490     if (ar->resrec.InterfaceID == mDNSInterface_Any)
2491     {
2492         result = mDNSPlatformValidRecordForInterface(ar, InterfaceID);
2493     }
2494     else
2495     {
2496         result = (ar->resrec.InterfaceID == InterfaceID);
2497     }
2498 
2499     return(result);
2500 }
2501 
2502 // Note about acceleration of announcements to facilitate automatic coalescing of
2503 // multiple independent threads of announcements into a single synchronized thread:
2504 // The announcements in the packet may be at different stages of maturity;
2505 // One-second interval, two-second interval, four-second interval, and so on.
2506 // After we've put in all the announcements that are due, we then consider
2507 // whether there are other nearly-due announcements that are worth accelerating.
2508 // To be eligible for acceleration, a record MUST NOT be older (further along
2509 // its timeline) than the most mature record we've already put in the packet.
2510 // In other words, younger records can have their timelines accelerated to catch up
2511 // with their elder bretheren; this narrows the age gap and helps them eventually get in sync.
2512 // Older records cannot have their timelines accelerated; this would just widen
2513 // the gap between them and their younger bretheren and get them even more out of sync.
2514 
2515 // Note: SendResponses calls mDNS_Deregister_internal which can call a user callback, which may change
2516 // the record list and/or question list.
2517 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2518 mDNSlocal void SendResponses(mDNS *const m)
2519 {
2520     int pktcount = 0;
2521     AuthRecord *rr, *r2;
2522     mDNSs32 maxExistingAnnounceInterval = 0;
2523     const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
2524 
2525     m->NextScheduledResponse = m->timenow + FutureTime;
2526 
2527     if (m->SleepState == SleepState_Transferring) RetrySPSRegistrations(m);
2528 
2529     for (rr = m->ResourceRecords; rr; rr=rr->next)
2530         if (rr->ImmedUnicast)
2531         {
2532             mDNSAddr v4 = { mDNSAddrType_IPv4, {{{0}}} };
2533             mDNSAddr v6 = { mDNSAddrType_IPv6, {{{0}}} };
2534             v4.ip.v4 = rr->v4Requester;
2535             v6.ip.v6 = rr->v6Requester;
2536             if (!mDNSIPv4AddressIsZero(rr->v4Requester)) SendDelayedUnicastResponse(m, &v4, rr->ImmedAnswer);
2537             if (!mDNSIPv6AddressIsZero(rr->v6Requester)) SendDelayedUnicastResponse(m, &v6, rr->ImmedAnswer);
2538             if (rr->ImmedUnicast)
2539             {
2540                 LogMsg("SendResponses: ERROR: rr->ImmedUnicast still set: %s", ARDisplayString(m, rr));
2541                 rr->ImmedUnicast = mDNSfalse;
2542             }
2543         }
2544 
2545     // ***
2546     // *** 1. Setup: Set the SendRNow and ImmedAnswer fields to indicate which interface(s) the records need to be sent on
2547     // ***
2548 
2549     // Run through our list of records, and decide which ones we're going to announce on all interfaces
2550     for (rr = m->ResourceRecords; rr; rr=rr->next)
2551     {
2552         while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
2553         if (TimeToAnnounceThisRecord(rr, m->timenow))
2554         {
2555             if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2556             {
2557                 if (!rr->WakeUp.HMAC.l[0])
2558                 {
2559                     if (rr->AnnounceCount) rr->ImmedAnswer = mDNSInterfaceMark;     // Send goodbye packet on all interfaces
2560                 }
2561                 else
2562                 {
2563                     mDNSBool unicastOnly;
2564                     LogSPS("SendResponses: Sending wakeup %2d for %.6a %s", rr->AnnounceCount-3, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
2565                     unicastOnly = ((rr->AnnounceCount == WakeupCount) || (rr->AnnounceCount == WakeupCount - 1)) ? mDNStrue : mDNSfalse;
2566                     SendWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.IMAC, &rr->WakeUp.password, unicastOnly);
2567                     for (r2 = rr; r2; r2=r2->next)
2568                         if ((r2->resrec.RecordType == kDNSRecordTypeDeregistering) && r2->AnnounceCount && (r2->resrec.InterfaceID == rr->resrec.InterfaceID) &&
2569                             mDNSSameEthAddress(&r2->WakeUp.IMAC, &rr->WakeUp.IMAC) && !mDNSSameEthAddress(&zeroEthAddr, &r2->WakeUp.HMAC))
2570                         {
2571                             // For now we only want to send a single Unsolicited Neighbor Advertisement restoring the address to the original
2572                             // owner, because these packets can cause some IPv6 stacks to falsely conclude that there's an address conflict.
2573                             if (r2->AddressProxy.type == mDNSAddrType_IPv6 && r2->AnnounceCount == WakeupCount)
2574                             {
2575                                 LogSPS("NDP Announcement %2d Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
2576                                        r2->AnnounceCount-3, &r2->WakeUp.HMAC, &r2->WakeUp.IMAC, ARDisplayString(m,r2));
2577                                 SendNDP(m, NDP_Adv, NDP_Override, r2, &r2->AddressProxy.ip.v6, &r2->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
2578                             }
2579                             r2->LastAPTime = m->timenow;
2580                             // After 15 wakeups without success (maybe host has left the network) send three goodbyes instead
2581                             if (--r2->AnnounceCount <= GoodbyeCount) r2->WakeUp.HMAC = zeroEthAddr;
2582                         }
2583                 }
2584             }
2585             else if (ResourceRecordIsValidAnswer(rr))
2586             {
2587                 if (rr->AddressProxy.type)
2588                 {
2589                     if (!mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
2590                     {
2591                         rr->AnnounceCount--;
2592                         rr->ThisAPInterval *= 2;
2593                         rr->LastAPTime = m->timenow;
2594                         if (rr->AddressProxy.type == mDNSAddrType_IPv4)
2595                         {
2596                             LogSPS("ARP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2597                                     rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2598                             SendARP(m, 1, rr, &rr->AddressProxy.ip.v4, &zeroEthAddr, &rr->AddressProxy.ip.v4, &onesEthAddr);
2599                         }
2600                         else if (rr->AddressProxy.type == mDNSAddrType_IPv6)
2601                         {
2602                             LogSPS("NDP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2603                                     rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2604                             SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
2605                         }
2606                     }
2607                 }
2608                 else
2609                 {
2610                     rr->ImmedAnswer = mDNSInterfaceMark;        // Send on all interfaces
2611                     if (maxExistingAnnounceInterval < rr->ThisAPInterval)
2612                         maxExistingAnnounceInterval = rr->ThisAPInterval;
2613                     if (rr->UpdateBlocked) rr->UpdateBlocked = 0;
2614                 }
2615             }
2616         }
2617     }
2618 
2619     // Any interface-specific records we're going to send are marked as being sent on all appropriate interfaces (which is just one)
2620     // Eligible records that are more than half-way to their announcement time are accelerated
2621     for (rr = m->ResourceRecords; rr; rr=rr->next)
2622         if ((rr->resrec.InterfaceID && rr->ImmedAnswer) ||
2623             (rr->ThisAPInterval <= maxExistingAnnounceInterval &&
2624              TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2) &&
2625              !rr->AddressProxy.type &&                  // Don't include ARP Annoucements when considering which records to accelerate
2626              ResourceRecordIsValidAnswer(rr)))
2627             rr->ImmedAnswer = mDNSInterfaceMark;        // Send on all interfaces
2628 
2629     // When sending SRV records (particularly when announcing a new service) automatically add related Address record(s) as additionals
2630     // Note: Currently all address records are interface-specific, so it's safe to set ImmedAdditional to their InterfaceID,
2631     // which will be non-null. If by some chance there is an address record that's not interface-specific (should never happen)
2632     // then all that means is that it won't get sent -- which would not be the end of the world.
2633     for (rr = m->ResourceRecords; rr; rr=rr->next)
2634     {
2635         if (rr->ImmedAnswer && rr->resrec.rrtype == kDNSType_SRV)
2636             for (r2=m->ResourceRecords; r2; r2=r2->next)                // Scan list of resource records
2637                 if (RRTypeIsAddressType(r2->resrec.rrtype) &&           // For all address records (A/AAAA) ...
2638                     ResourceRecordIsValidAnswer(r2) &&                  // ... which are valid for answer ...
2639                     rr->LastMCTime - r2->LastMCTime >= 0 &&             // ... which we have not sent recently ...
2640                     rr->resrec.rdatahash == r2->resrec.namehash &&      // ... whose name is the name of the SRV target
2641                     SameDomainName(&rr->resrec.rdata->u.srv.target, r2->resrec.name) &&
2642                     (rr->ImmedAnswer == mDNSInterfaceMark || rr->ImmedAnswer == r2->resrec.InterfaceID))
2643                     r2->ImmedAdditional = r2->resrec.InterfaceID;       // ... then mark this address record for sending too
2644         // We also make sure we send the DeviceInfo TXT record too, if necessary
2645         // We check for RecordType == kDNSRecordTypeShared because we don't want to tag the
2646         // DeviceInfo TXT record onto a goodbye packet (RecordType == kDNSRecordTypeDeregistering).
2647         if (rr->ImmedAnswer && rr->resrec.RecordType == kDNSRecordTypeShared && rr->resrec.rrtype == kDNSType_PTR)
2648             if (ResourceRecordIsValidAnswer(&m->DeviceInfo) && SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2649             {
2650                 if (!m->DeviceInfo.ImmedAnswer) m->DeviceInfo.ImmedAnswer = rr->ImmedAnswer;
2651                 else m->DeviceInfo.ImmedAnswer = mDNSInterfaceMark;
2652             }
2653     }
2654 
2655     // If there's a record which is supposed to be unique that we're going to send, then make sure that we give
2656     // the whole RRSet as an atomic unit. That means that if we have any other records with the same name/type/class
2657     // then we need to mark them for sending too. Otherwise, if we set the kDNSClass_UniqueRRSet bit on a
2658     // record, then other RRSet members that have not been sent recently will get flushed out of client caches.
2659     // -- 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
2660     // -- If any record is marked to be sent on all interfaces, make sure the whole set is marked to be sent on all interfaces
2661     for (rr = m->ResourceRecords; rr; rr=rr->next)
2662         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2663         {
2664             if (rr->ImmedAnswer)            // If we're sending this as answer, see that its whole RRSet is similarly marked
2665             {
2666                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2667                 {
2668                     if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2669                         (r2->ImmedAnswer != mDNSInterfaceMark) && (r2->ImmedAnswer != rr->ImmedAnswer) &&
2670                         SameResourceRecordSignature(r2, rr) &&
2671                         ((rr->ImmedAnswer == mDNSInterfaceMark) || IsInterfaceValidForAuthRecord(r2, rr->ImmedAnswer)))
2672                     {
2673                         r2->ImmedAnswer = !r2->ImmedAnswer ? rr->ImmedAnswer : mDNSInterfaceMark;
2674                     }
2675                 }
2676             }
2677             else if (rr->ImmedAdditional)   // If we're sending this as additional, see that its whole RRSet is similarly marked
2678             {
2679                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2680                 {
2681                     if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2682                         (r2->ImmedAdditional != rr->ImmedAdditional) &&
2683                         SameResourceRecordSignature(r2, rr) &&
2684                         IsInterfaceValidForAuthRecord(r2, rr->ImmedAdditional))
2685                     {
2686                         r2->ImmedAdditional = rr->ImmedAdditional;
2687                     }
2688                 }
2689             }
2690         }
2691 
2692     // Now set SendRNow state appropriately
2693     for (rr = m->ResourceRecords; rr; rr=rr->next)
2694     {
2695         if (rr->ImmedAnswer == mDNSInterfaceMark)       // Sending this record on all appropriate interfaces
2696         {
2697             rr->SendRNow = !intf ? mDNSNULL : (rr->resrec.InterfaceID) ? rr->resrec.InterfaceID : intf->InterfaceID;
2698             rr->ImmedAdditional = mDNSNULL;             // No need to send as additional if sending as answer
2699             rr->LastMCTime      = m->timenow;
2700             rr->LastMCInterface = rr->ImmedAnswer;
2701             rr->ProbeRestartCount = 0;                  // Reset the probe restart count
2702             // If we're announcing this record, and it's at least half-way to its ordained time, then consider this announcement done
2703             if (TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2))
2704             {
2705                 rr->AnnounceCount--;
2706                 if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
2707                     rr->ThisAPInterval *= 2;
2708                 rr->LastAPTime = m->timenow;
2709                 debugf("Announcing %##s (%s) %d", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->AnnounceCount);
2710             }
2711         }
2712         else if (rr->ImmedAnswer)                       // Else, just respond to a single query on single interface:
2713         {
2714             rr->SendRNow        = rr->ImmedAnswer;      // Just respond on that interface
2715             rr->ImmedAdditional = mDNSNULL;             // No need to send as additional too
2716             rr->LastMCTime      = m->timenow;
2717             rr->LastMCInterface = rr->ImmedAnswer;
2718         }
2719         SetNextAnnounceProbeTime(m, rr);
2720         //if (rr->SendRNow) LogMsg("%-15.4a %s", &rr->v4Requester, ARDisplayString(m, rr));
2721     }
2722 
2723     // ***
2724     // *** 2. Loop through interface list, sending records as appropriate
2725     // ***
2726 
2727     while (intf)
2728     {
2729         int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
2730         int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
2731         int numDereg    = 0;
2732         int numAnnounce = 0;
2733         int numAnswer   = 0;
2734         int AnoninfoSpace = 0;
2735         mDNSu8 *responseptr = m->omsg.data;
2736         mDNSu8 *newptr;
2737         InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2738 
2739         // First Pass. Look for:
2740         // 1. Deregistering records that need to send their goodbye packet
2741         // 2. Updated records that need to retract their old data
2742         // 3. Answers and announcements we need to send
2743         for (rr = m->ResourceRecords; rr; rr=rr->next)
2744         {
2745 
2746             // Skip this interface if the record InterfaceID is *Any and the record is not
2747             // appropriate for the interface type.
2748             if ((rr->SendRNow == intf->InterfaceID) &&
2749                 ((rr->resrec.InterfaceID == mDNSInterface_Any) && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID)))
2750             {
2751                 rr->SendRNow = GetNextActiveInterfaceID(intf);
2752             }
2753             else if (rr->SendRNow == intf->InterfaceID)
2754             {
2755                 RData  *OldRData    = rr->resrec.rdata;
2756                 mDNSu16 oldrdlength = rr->resrec.rdlength;
2757                 mDNSu8 active = (mDNSu8)
2758                                 (rr->resrec.RecordType != kDNSRecordTypeDeregistering && !ShouldSendGoodbyesBeforeSleep(m, intf, rr));
2759                 newptr = mDNSNULL;
2760                 if (rr->NewRData && active)
2761                 {
2762                     // See if we should send a courtesy "goodbye" for the old data before we replace it.
2763                     if (ResourceRecordIsValidAnswer(rr) && rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
2764                     {
2765                         newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, 0);
2766                         if (newptr) { responseptr = newptr; numDereg++; rr->RequireGoodbye = mDNSfalse; }
2767                         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
2768                     }
2769                     SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);
2770                 }
2771 
2772                 if (rr->resrec.AnonInfo)
2773                 {
2774                     int tmp = AnonInfoSpace(rr->resrec.AnonInfo);
2775 
2776                     AnoninfoSpace += tmp;
2777                     // Adjust OwnerRecordSpace/TraceRecordSpace which is used by PutRR_OS_TTL below so that
2778                     // we have space to put in the NSEC3 record in the authority section.
2779                     OwnerRecordSpace += tmp;
2780                     TraceRecordSpace += tmp;
2781                 }
2782 
2783                 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2784                     rr->resrec.rrclass |= kDNSClass_UniqueRRSet;        // Temporarily set the cache flush bit so PutResourceRecord will set it
2785                 newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, active ? rr->resrec.rroriginalttl : 0);
2786                 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;           // Make sure to clear cache flush bit back to normal state
2787                 if (newptr)
2788                 {
2789                     responseptr = newptr;
2790                     rr->RequireGoodbye = active;
2791                     if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) numDereg++;
2792                     else if (rr->LastAPTime == m->timenow) numAnnounce++;else numAnswer++;
2793                 }
2794 
2795                 if (rr->NewRData && active)
2796                     SetNewRData(&rr->resrec, OldRData, oldrdlength);
2797 
2798                 // The first time through (pktcount==0), if this record is verified unique
2799                 // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2800                 if (!pktcount && active && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2801                     rr->SendNSECNow = mDNSInterfaceMark;
2802 
2803                 if (newptr)     // If succeeded in sending, advance to next interface
2804                 {
2805                     if (rr->resrec.AnonInfo)
2806                     {
2807                         debugf("SendResponses: Marking %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2808                                 TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2809                         rr->resrec.AnonInfo->SendNow = intf->InterfaceID;
2810                     }
2811 
2812                     // If sending on all interfaces, go to next interface; else we're finished now
2813                     if (rr->ImmedAnswer == mDNSInterfaceMark && rr->resrec.InterfaceID == mDNSInterface_Any)
2814                         rr->SendRNow = GetNextActiveInterfaceID(intf);
2815                     else
2816                         rr->SendRNow = mDNSNULL;
2817                 }
2818             }
2819         }
2820 
2821         // Get the reserved space back
2822         OwnerRecordSpace -= AnoninfoSpace;
2823         TraceRecordSpace -= AnoninfoSpace;
2824         newptr = responseptr;
2825         for (rr = m->ResourceRecords; rr; rr=rr->next)
2826         {
2827             if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == intf->InterfaceID)
2828             {
2829                 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2830 
2831                 newptr = PutRR_OS_TTL(newptr, &m->omsg.h.numAuthorities, nsec3RR,  nsec3RR->rroriginalttl);
2832                 if (newptr)
2833                 {
2834                     responseptr = newptr;
2835                     debugf("SendResponses: Added NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2836                             TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2837                 }
2838                 else
2839                 {
2840                     LogMsg("SendResponses: Cannot add NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2841                             TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2842                 }
2843                 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2844             }
2845         }
2846         // Second Pass. Add additional records, if there's space.
2847         newptr = responseptr;
2848         for (rr = m->ResourceRecords; rr; rr=rr->next)
2849             if (rr->ImmedAdditional == intf->InterfaceID)
2850                 if (ResourceRecordIsValidAnswer(rr))
2851                 {
2852                     // If we have at least one answer already in the packet, then plan to add additionals too
2853                     mDNSBool SendAdditional = (m->omsg.h.numAnswers > 0);
2854 
2855                     // If we're not planning to send any additionals, but this record is a unique one, then
2856                     // make sure we haven't already sent any other members of its RRSet -- if we have, then they
2857                     // will have had the cache flush bit set, so now we need to finish the job and send the rest.
2858                     if (!SendAdditional && (rr->resrec.RecordType & kDNSRecordTypeUniqueMask))
2859                     {
2860                         const AuthRecord *a;
2861                         for (a = m->ResourceRecords; a; a=a->next)
2862                             if (a->LastMCTime      == m->timenow &&
2863                                 a->LastMCInterface == intf->InterfaceID &&
2864                                 SameResourceRecordSignature(a, rr)) { SendAdditional = mDNStrue; break; }
2865                     }
2866                     if (!SendAdditional)                    // If we don't want to send this after all,
2867                         rr->ImmedAdditional = mDNSNULL;     // then cancel its ImmedAdditional field
2868                     else if (newptr)                        // Else, try to add it if we can
2869                     {
2870                         // The first time through (pktcount==0), if this record is verified unique
2871                         // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2872                         if (!pktcount && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2873                             rr->SendNSECNow = mDNSInterfaceMark;
2874 
2875                         if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2876                             rr->resrec.rrclass |= kDNSClass_UniqueRRSet;    // Temporarily set the cache flush bit so PutResourceRecord will set it
2877                         newptr = PutRR_OS(newptr, &m->omsg.h.numAdditionals, &rr->resrec);
2878                         rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;       // Make sure to clear cache flush bit back to normal state
2879                         if (newptr)
2880                         {
2881                             responseptr = newptr;
2882                             rr->ImmedAdditional = mDNSNULL;
2883                             rr->RequireGoodbye = mDNStrue;
2884                             // If we successfully put this additional record in the packet, we record LastMCTime & LastMCInterface.
2885                             // This matters particularly in the case where we have more than one IPv6 (or IPv4) address, because otherwise,
2886                             // when we see our own multicast with the cache flush bit set, if we haven't set LastMCTime, then we'll get
2887                             // all concerned and re-announce our record again to make sure it doesn't get flushed from peer caches.
2888                             rr->LastMCTime      = m->timenow;
2889                             rr->LastMCInterface = intf->InterfaceID;
2890                         }
2891                     }
2892                 }
2893 
2894         // Third Pass. Add NSEC records, if there's space.
2895         // When we're generating an NSEC record in response to a specify query for that type
2896         // (recognized by rr->SendNSECNow == intf->InterfaceID) we should really put the NSEC in the Answer Section,
2897         // not Additional Section, but for now it's easier to handle both cases in this Additional Section loop here.
2898         for (rr = m->ResourceRecords; rr; rr=rr->next)
2899             if (rr->SendNSECNow == mDNSInterfaceMark || rr->SendNSECNow == intf->InterfaceID)
2900             {
2901                 AuthRecord nsec;
2902                 mDNSu8 *ptr;
2903                 int len;
2904                 mDNS_SetupResourceRecord(&nsec, mDNSNULL, mDNSInterface_Any, kDNSType_NSEC, rr->resrec.rroriginalttl, kDNSRecordTypeUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2905                 nsec.resrec.rrclass |= kDNSClass_UniqueRRSet;
2906                 AssignDomainName(&nsec.namestorage, rr->resrec.name);
2907                 ptr = nsec.rdatastorage.u.data;
2908                 len = DomainNameLength(rr->resrec.name);
2909                 // We have a nxt name followed by window number, window length and a window bitmap
2910                 nsec.resrec.rdlength = len + 2 + NSEC_MCAST_WINDOW_SIZE;
2911                 if (nsec.resrec.rdlength <= StandardAuthRDSize)
2912                 {
2913                     mDNSPlatformMemZero(ptr, nsec.resrec.rdlength);
2914                     AssignDomainName((domainname *)ptr, rr->resrec.name);
2915                     ptr += len;
2916                     *ptr++ = 0; // window number
2917                     *ptr++ = NSEC_MCAST_WINDOW_SIZE; // window length
2918                     for (r2 = m->ResourceRecords; r2; r2=r2->next)
2919                         if (ResourceRecordIsValidAnswer(r2) && SameResourceRecordNameClassInterface(r2, rr))
2920                         {
2921                             if (r2->resrec.rrtype >= kDNSQType_ANY) { LogMsg("SendResponses: Can't create NSEC for record %s", ARDisplayString(m, r2)); break; }
2922                             else ptr[r2->resrec.rrtype >> 3] |= 128 >> (r2->resrec.rrtype & 7);
2923                         }
2924                     newptr = responseptr;
2925                     if (!r2)    // If we successfully built our NSEC record, add it to the packet now
2926                     {
2927                         newptr = PutRR_OS(responseptr, &m->omsg.h.numAdditionals, &nsec.resrec);
2928                         if (newptr) responseptr = newptr;
2929                     }
2930                 }
2931                 else LogMsg("SendResponses: not enough space (%d)  in authrecord for nsec", nsec.resrec.rdlength);
2932 
2933                 // If we successfully put the NSEC record, clear the SendNSECNow flag
2934                 // If we consider this NSEC optional, then we unconditionally clear the SendNSECNow flag, even if we fail to put this additional record
2935                 if (newptr || rr->SendNSECNow == mDNSInterfaceMark)
2936                 {
2937                     rr->SendNSECNow = mDNSNULL;
2938                     // Run through remainder of list clearing SendNSECNow flag for all other records which would generate the same NSEC
2939                     for (r2 = rr->next; r2; r2=r2->next)
2940                         if (SameResourceRecordNameClassInterface(r2, rr))
2941                             if (r2->SendNSECNow == mDNSInterfaceMark || r2->SendNSECNow == intf->InterfaceID)
2942                                 r2->SendNSECNow = mDNSNULL;
2943                 }
2944             }
2945 
2946         if (m->omsg.h.numAnswers || m->omsg.h.numAdditionals)
2947         {
2948             // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
2949             if (OwnerRecordSpace || TraceRecordSpace)
2950             {
2951                 AuthRecord opt;
2952                 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2953                 opt.resrec.rrclass    = NormalMaxDNSMessageData;
2954                 opt.resrec.rdlength   = sizeof(rdataOPT);
2955                 opt.resrec.rdestimate = sizeof(rdataOPT);
2956                 if (OwnerRecordSpace && TraceRecordSpace)
2957                 {
2958                     opt.resrec.rdlength   += sizeof(rdataOPT); // Two options in this OPT record
2959                     opt.resrec.rdestimate += sizeof(rdataOPT);
2960                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2961                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
2962                 }
2963                 else if (OwnerRecordSpace)
2964                 {
2965                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2966                 }
2967                 else if (TraceRecordSpace)
2968                 {
2969                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
2970                 }
2971                 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &opt.resrec);
2972                 if (newptr)
2973                 {
2974                     responseptr = newptr;
2975                 }
2976                 else if (m->omsg.h.numAnswers + m->omsg.h.numAuthorities + m->omsg.h.numAdditionals == 1)
2977                 {
2978                     LogInfo("SendResponses: No space in packet for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2979                             m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2980                 }
2981                 else
2982                 {
2983                     LogMsg("SendResponses: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2984                            m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2985                 }
2986             }
2987 
2988             debugf("SendResponses: Sending %d Deregistration%s, %d Announcement%s, %d Answer%s, %d Additional%s on %p",
2989                    numDereg,                 numDereg                 == 1 ? "" : "s",
2990                    numAnnounce,              numAnnounce              == 1 ? "" : "s",
2991                    numAnswer,                numAnswer                == 1 ? "" : "s",
2992                    m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s", intf->InterfaceID);
2993 
2994             if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2995             if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2996             if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
2997             if (++pktcount >= 1000) { LogMsg("SendResponses exceeded loop limit %d: giving up", pktcount); break; }
2998             // There might be more things to send on this interface, so go around one more time and try again.
2999         }
3000         else    // Nothing more to send on this interface; go to next
3001         {
3002             const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3003             #if MDNS_DEBUGMSGS && 0
3004             const char *const msg = next ? "SendResponses: Nothing more on %p; moving to %p" : "SendResponses: Nothing more on %p";
3005             debugf(msg, intf, next);
3006             #endif
3007             intf = next;
3008             pktcount = 0;       // When we move to a new interface, reset packet count back to zero -- NSEC generation logic uses it
3009         }
3010     }
3011 
3012     // ***
3013     // *** 3. Cleanup: Now that everything is sent, call client callback functions, and reset state variables
3014     // ***
3015 
3016     if (m->CurrentRecord)
3017         LogMsg("SendResponses ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3018     m->CurrentRecord = m->ResourceRecords;
3019     while (m->CurrentRecord)
3020     {
3021         rr = m->CurrentRecord;
3022         m->CurrentRecord = rr->next;
3023 
3024         if (rr->SendRNow)
3025         {
3026             if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P)
3027                 LogInfo("SendResponses: No active interface %d to send: %d %02X %s",
3028                      (uint32_t)rr->SendRNow, (uint32_t)rr->resrec.InterfaceID, rr->resrec.RecordType, ARDisplayString(m, rr));
3029             rr->SendRNow = mDNSNULL;
3030         }
3031 
3032         if (rr->ImmedAnswer || rr->resrec.RecordType == kDNSRecordTypeDeregistering)
3033         {
3034             if (rr->NewRData) CompleteRDataUpdate(m, rr);   // Update our rdata, clear the NewRData pointer, and return memory to the client
3035 
3036             if (rr->resrec.RecordType == kDNSRecordTypeDeregistering && rr->AnnounceCount == 0)
3037             {
3038                 // For Unicast, when we get the response from the server, we will call CompleteDeregistration
3039                 if (!AuthRecord_uDNS(rr)) CompleteDeregistration(m, rr);        // Don't touch rr after this
3040             }
3041             else
3042             {
3043                 rr->ImmedAnswer  = mDNSNULL;
3044                 rr->ImmedUnicast = mDNSfalse;
3045                 rr->v4Requester  = zerov4Addr;
3046                 rr->v6Requester  = zerov6Addr;
3047             }
3048         }
3049     }
3050     verbosedebugf("SendResponses: Next in %ld ticks", m->NextScheduledResponse - m->timenow);
3051 }
3052 
3053 // Calling CheckCacheExpiration() is an expensive operation because it has to look at the entire cache,
3054 // so we want to be lazy about how frequently we do it.
3055 // 1. If a cache record is currently referenced by *no* active questions,
3056 //    then we don't mind expiring it up to a minute late (who will know?)
3057 // 2. Else, if a cache record is due for some of its final expiration queries,
3058 //    we'll allow them to be late by up to 2% of the TTL
3059 // 3. Else, if a cache record has completed all its final expiration queries without success,
3060 //    and is expiring, and had an original TTL more than ten seconds, we'll allow it to be one second late
3061 // 4. Else, it is expiring and had an original TTL of ten seconds or less (includes explicit goodbye packets),
3062 //    so allow at most 1/10 second lateness
3063 // 5. For records with rroriginalttl set to zero, that means we really want to delete them immediately
3064 //    (we have a new record with DelayDelivery set, waiting for the old record to go away before we can notify clients).
3065 #define CacheCheckGracePeriod(RR) (                                                   \
3066         ((RR)->CRActiveQuestion == mDNSNULL            ) ? (60 * mDNSPlatformOneSecond) : \
3067         ((RR)->UnansweredQueries < MaxUnansweredQueries) ? (TicksTTL(rr)/50)            : \
3068         ((RR)->resrec.rroriginalttl > 10               ) ? (mDNSPlatformOneSecond)      : \
3069         ((RR)->resrec.rroriginalttl > 0                ) ? (mDNSPlatformOneSecond/10)   : 0)
3070 
3071 #define NextCacheCheckEvent(RR) ((RR)->NextRequiredQuery + CacheCheckGracePeriod(RR))
3072 
3073 mDNSexport void ScheduleNextCacheCheckTime(mDNS *const m, const mDNSu32 slot, const mDNSs32 event)
3074 {
3075     if (m->rrcache_nextcheck[slot] - event > 0)
3076         m->rrcache_nextcheck[slot] = event;
3077     if (m->NextCacheCheck          - event > 0)
3078         m->NextCacheCheck          = event;
3079 }
3080 
3081 // Note: MUST call SetNextCacheCheckTimeForRecord any time we change:
3082 // rr->TimeRcvd
3083 // rr->resrec.rroriginalttl
3084 // rr->UnansweredQueries
3085 // rr->CRActiveQuestion
3086 mDNSexport void SetNextCacheCheckTimeForRecord(mDNS *const m, CacheRecord *const rr)
3087 {
3088     rr->NextRequiredQuery = RRExpireTime(rr);
3089 
3090     // If we have an active question, then see if we want to schedule a refresher query for this record.
3091     // Usually we expect to do four queries, at 80-82%, 85-87%, 90-92% and then 95-97% of the TTL.
3092     if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
3093     {
3094         rr->NextRequiredQuery -= TicksTTL(rr)/20 * (MaxUnansweredQueries - rr->UnansweredQueries);
3095         rr->NextRequiredQuery += mDNSRandom((mDNSu32)TicksTTL(rr)/50);
3096         verbosedebugf("SetNextCacheCheckTimeForRecord: NextRequiredQuery in %ld sec CacheCheckGracePeriod %d ticks for %s",
3097                       (rr->NextRequiredQuery - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m,rr));
3098     }
3099     ScheduleNextCacheCheckTime(m, HashSlotFromNameHash(rr->resrec.namehash), NextCacheCheckEvent(rr));
3100 }
3101 
3102 #define kMinimumReconfirmTime                     ((mDNSu32)mDNSPlatformOneSecond *  5)
3103 #define kDefaultReconfirmTimeForWake              ((mDNSu32)mDNSPlatformOneSecond *  5)
3104 #define kDefaultReconfirmTimeForNoAnswer          ((mDNSu32)mDNSPlatformOneSecond *  5)
3105 
3106 // Delay before restarting questions on a flapping interface.
3107 #define kDefaultQueryDelayTimeForFlappingInterface ((mDNSu32)mDNSPlatformOneSecond *  3)
3108 // After kDefaultQueryDelayTimeForFlappingInterface seconds, allow enough time for up to three queries (0, 1, and 4 seconds)
3109 // plus three seconds for "response delay" before removing the reconfirmed records from the cache.
3110 #define kDefaultReconfirmTimeForFlappingInterface (kDefaultQueryDelayTimeForFlappingInterface + ((mDNSu32)mDNSPlatformOneSecond *  7))
3111 
3112 mDNSexport mStatus mDNS_Reconfirm_internal(mDNS *const m, CacheRecord *const rr, mDNSu32 interval)
3113 {
3114     if (interval < kMinimumReconfirmTime)
3115         interval = kMinimumReconfirmTime;
3116     if (interval > 0x10000000)  // Make sure interval doesn't overflow when we multiply by four below
3117         interval = 0x10000000;
3118 
3119     // If the expected expiration time for this record is more than interval+33%, then accelerate its expiration
3120     if (RRExpireTime(rr) - m->timenow > (mDNSs32)((interval * 4) / 3))
3121     {
3122         // Add a 33% random amount to the interval, to avoid synchronization between multiple hosts
3123         // For all the reconfirmations in a given batch, we want to use the same random value
3124         // so that the reconfirmation questions can be grouped into a single query packet
3125         if (!m->RandomReconfirmDelay) m->RandomReconfirmDelay = 1 + mDNSRandom(FutureTime);
3126         interval += m->RandomReconfirmDelay % ((interval/3) + 1);
3127         rr->TimeRcvd          = m->timenow - (mDNSs32)interval * 3;
3128         rr->resrec.rroriginalttl     = (interval * 4 + mDNSPlatformOneSecond - 1) / mDNSPlatformOneSecond;
3129         SetNextCacheCheckTimeForRecord(m, rr);
3130     }
3131     debugf("mDNS_Reconfirm_internal:%6ld ticks to go for %s %p",
3132            RRExpireTime(rr) - m->timenow, CRDisplayString(m, rr), rr->CRActiveQuestion);
3133     return(mStatus_NoError);
3134 }
3135 
3136 // BuildQuestion puts a question into a DNS Query packet and if successful, updates the value of queryptr.
3137 // It also appends to the list of known answer records that need to be included,
3138 // and updates the forcast for the size of the known answer section.
3139 mDNSlocal mDNSBool BuildQuestion(mDNS *const m, const NetworkInterfaceInfo *intf, DNSMessage *query, mDNSu8 **queryptr,
3140                                  DNSQuestion *q, CacheRecord ***kalistptrptr, mDNSu32 *answerforecast)
3141 {
3142     mDNSBool ucast = (q->LargeAnswers || q->RequestUnicast) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3143     mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3144     const mDNSu8 *const limit = query->data + NormalMaxDNSMessageData;
3145     mDNSu8 anoninfo_space = q->AnonInfo ? AnonInfoSpace(q->AnonInfo) : 0;
3146     mDNSu8 *newptr = putQuestion(query, *queryptr, limit - *answerforecast - anoninfo_space, &q->qname, q->qtype, (mDNSu16)(q->qclass | ucbit));
3147     if (!newptr)
3148     {
3149         debugf("BuildQuestion: No more space in this packet for question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
3150         return(mDNSfalse);
3151     }
3152     else
3153     {
3154         mDNSu32 forecast = *answerforecast + anoninfo_space;
3155         const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3156         CacheRecord *rr;
3157         CacheRecord **ka = *kalistptrptr;   // Make a working copy of the pointer we're going to update
3158 
3159         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // If we have a resource record in our cache,
3160             if (rr->resrec.InterfaceID == q->SendQNow &&                    // received on this interface
3161                 !(rr->resrec.RecordType & kDNSRecordTypeUniqueMask) &&      // which is a shared (i.e. not unique) record type
3162                 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList &&  // which is not already in the known answer list
3163                 rr->resrec.rdlength <= SmallRecordLimit &&                  // which is small enough to sensibly fit in the packet
3164                 SameNameRecordAnswersQuestion(&rr->resrec, q) &&            // which answers our question
3165                 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow >                // and its half-way-to-expiry time is at least 1 second away
3166                 mDNSPlatformOneSecond)                                      // (also ensures we never include goodbye records with TTL=1)
3167             {
3168                 // We don't want to include unique records in the Known Answer section. The Known Answer section
3169                 // is intended to suppress floods of shared-record replies from many other devices on the network.
3170                 // That concept really does not apply to unique records, and indeed if we do send a query for
3171                 // which we have a unique record already in our cache, then including that unique record as a
3172                 // Known Answer, so as to suppress the only answer we were expecting to get, makes little sense.
3173 
3174                 *ka = rr;   // Link this record into our known answer chain
3175                 ka = &rr->NextInKAList;
3176                 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3177                 forecast += 12 + rr->resrec.rdestimate;
3178                 // If we're trying to put more than one question in this packet, and it doesn't fit
3179                 // then undo that last question and try again next time
3180                 if (query->h.numQuestions > 1 && newptr + forecast >= limit)
3181                 {
3182                     query->h.numQuestions--;
3183                     debugf("BuildQuestion: Retracting question %##s (%s) new forecast total %d, total questions %d",
3184                            q->qname.c, DNSTypeName(q->qtype), newptr + forecast - query->data, query->h.numQuestions);
3185                     ka = *kalistptrptr;     // Go back to where we started and retract these answer records
3186                     while (*ka) { CacheRecord *c = *ka; *ka = mDNSNULL; ka = &c->NextInKAList; }
3187                     return(mDNSfalse);      // Return false, so we'll try again in the next packet
3188                 }
3189             }
3190 
3191         // Success! Update our state pointers, increment UnansweredQueries as appropriate, and return
3192         *queryptr        = newptr;              // Update the packet pointer
3193         *answerforecast  = forecast;            // Update the forecast
3194         *kalistptrptr    = ka;                  // Update the known answer list pointer
3195         if (ucast) q->ExpectUnicastResp = NonZeroTime(m->timenow);
3196 
3197         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // For every resource record in our cache,
3198             if (rr->resrec.InterfaceID == q->SendQNow &&                    // received on this interface
3199                 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList &&  // which is not in the known answer list
3200                 SameNameRecordAnswersQuestion(&rr->resrec, q))              // which answers our question
3201             {
3202                 rr->UnansweredQueries++;                                    // indicate that we're expecting a response
3203                 rr->LastUnansweredTime = m->timenow;
3204                 SetNextCacheCheckTimeForRecord(m, rr);
3205             }
3206 
3207         return(mDNStrue);
3208     }
3209 }
3210 
3211 // When we have a query looking for a specified name, but there appear to be no answers with
3212 // that name, ReconfirmAntecedents() is called with depth=0 to start the reconfirmation process
3213 // for any records in our cache that reference the given name (e.g. PTR and SRV records).
3214 // For any such cache record we find, we also recursively call ReconfirmAntecedents() for *its* name.
3215 // We increment depth each time we recurse, to guard against possible infinite loops, with a limit of 5.
3216 // A typical reconfirmation scenario might go like this:
3217 // Depth 0: Name "myhost.local" has no address records
3218 // Depth 1: SRV "My Service._example._tcp.local." refers to "myhost.local"; may be stale
3219 // Depth 2: PTR "_example._tcp.local." refers to "My Service"; may be stale
3220 // Depth 3: PTR "_services._dns-sd._udp.local." refers to "_example._tcp.local."; may be stale
3221 // Currently depths 4 and 5 are not expected to occur; if we did get to depth 5 we'd reconfim any records we
3222 // found referring to the given name, but not recursively descend any further reconfirm *their* antecedents.
3223 mDNSlocal void ReconfirmAntecedents(mDNS *const m, const domainname *const name, const mDNSu32 namehash, const int depth)
3224 {
3225     mDNSu32 slot;
3226     CacheGroup *cg;
3227     CacheRecord *cr;
3228     debugf("ReconfirmAntecedents (depth=%d) for %##s", depth, name->c);
3229     FORALL_CACHERECORDS(slot, cg, cr)
3230     {
3231         domainname *crtarget = GetRRDomainNameTarget(&cr->resrec);
3232         if (crtarget && cr->resrec.rdatahash == namehash && SameDomainName(crtarget, name))
3233         {
3234             LogInfo("ReconfirmAntecedents: Reconfirming (depth=%d) %s", depth, CRDisplayString(m, cr));
3235             mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
3236             if (depth < 5)
3237                 ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, depth+1);
3238         }
3239     }
3240 }
3241 
3242 // If we get no answer for a AAAA query, then before doing an automatic implicit ReconfirmAntecedents
3243 // we check if we have an address record for the same name. If we do have an IPv4 address for a given
3244 // name but not an IPv6 address, that's okay (it just means the device doesn't do IPv6) so the failure
3245 // to get a AAAA response is not grounds to doubt the PTR/SRV chain that lead us to that name.
3246 mDNSlocal const CacheRecord *CacheHasAddressTypeForName(mDNS *const m, const domainname *const name, const mDNSu32 namehash)
3247 {
3248     CacheGroup *const cg = CacheGroupForName(m, namehash, name);
3249     const CacheRecord *cr = cg ? cg->members : mDNSNULL;
3250     while (cr && !RRTypeIsAddressType(cr->resrec.rrtype)) cr=cr->next;
3251     return(cr);
3252 }
3253 
3254 
3255 mDNSlocal const CacheRecord *FindSPSInCache1(mDNS *const m, const DNSQuestion *const q, const CacheRecord *const c0, const CacheRecord *const c1)
3256 {
3257 #ifndef SPC_DISABLED
3258     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3259     const CacheRecord *cr, *bestcr = mDNSNULL;
3260     mDNSu32 bestmetric = 1000000;
3261     for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
3262         if (cr->resrec.rrtype == kDNSType_PTR && cr->resrec.rdlength >= 6)                      // If record is PTR type, with long enough name,
3263             if (cr != c0 && cr != c1)                                                           // that's not one we've seen before,
3264                 if (SameNameRecordAnswersQuestion(&cr->resrec, q))                              // and answers our browse query,
3265                     if (!IdenticalSameNameRecord(&cr->resrec, &m->SPSRecords.RR_PTR.resrec))    // and is not our own advertised service...
3266                     {
3267                         mDNSu32 metric = SPSMetric(cr->resrec.rdata->u.name.c);
3268                         if (bestmetric > metric) { bestmetric = metric; bestcr = cr; }
3269                     }
3270     return(bestcr);
3271 #else // SPC_DISABLED
3272     (void) m;
3273     (void) q;
3274     (void) c0;
3275     (void) c1;
3276     (void) c1;
3277     return mDNSNULL;
3278 #endif // SPC_DISABLED
3279 }
3280 
3281 mDNSlocal void CheckAndSwapSPS(const CacheRecord **sps1, const CacheRecord **sps2)
3282 {
3283     const CacheRecord *swap_sps;
3284     mDNSu32 metric1, metric2;
3285 
3286     if (!(*sps1) || !(*sps2)) return;
3287     metric1 = SPSMetric((*sps1)->resrec.rdata->u.name.c);
3288     metric2 = SPSMetric((*sps2)->resrec.rdata->u.name.c);
3289     if (!SPSFeatures((*sps1)->resrec.rdata->u.name.c) && SPSFeatures((*sps2)->resrec.rdata->u.name.c) && (metric2 >= metric1))
3290     {
3291         swap_sps = *sps1;
3292         *sps1    = *sps2;
3293         *sps2    = swap_sps;
3294     }
3295 }
3296 
3297 mDNSlocal void ReorderSPSByFeature(const CacheRecord *sps[3])
3298 {
3299     CheckAndSwapSPS(&sps[0], &sps[1]);
3300     CheckAndSwapSPS(&sps[0], &sps[2]);
3301     CheckAndSwapSPS(&sps[1], &sps[2]);
3302 }
3303 
3304 
3305 // Finds the three best Sleep Proxies we currently have in our cache
3306 mDNSexport void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3])
3307 {
3308     sps[0] =                      FindSPSInCache1(m, q, mDNSNULL, mDNSNULL);
3309     sps[1] = !sps[0] ? mDNSNULL : FindSPSInCache1(m, q, sps[0],   mDNSNULL);
3310     sps[2] = !sps[1] ? mDNSNULL : FindSPSInCache1(m, q, sps[0],   sps[1]);
3311 
3312     // SPS is already sorted by metric. We want to move the entries to the beginning of the array
3313     // only if they have equally good metric and support features.
3314     ReorderSPSByFeature(sps);
3315 }
3316 
3317 // Only DupSuppressInfos newer than the specified 'time' are allowed to remain active
3318 mDNSlocal void ExpireDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time)
3319 {
3320     int i;
3321     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3322 }
3323 
3324 mDNSlocal void ExpireDupSuppressInfoOnInterface(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time, mDNSInterfaceID InterfaceID)
3325 {
3326     int i;
3327     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3328 }
3329 
3330 mDNSlocal mDNSBool SuppressOnThisInterface(const DupSuppressInfo ds[DupSuppressInfoSize], const NetworkInterfaceInfo * const intf)
3331 {
3332     int i;
3333     mDNSBool v4 = !intf->IPv4Available;     // If this interface doesn't do v4, we don't need to find a v4 duplicate of this query
3334     mDNSBool v6 = !intf->IPv6Available;     // If this interface doesn't do v6, we don't need to find a v6 duplicate of this query
3335     for (i=0; i<DupSuppressInfoSize; i++)
3336         if (ds[i].InterfaceID == intf->InterfaceID)
3337         {
3338             if      (ds[i].Type == mDNSAddrType_IPv4) v4 = mDNStrue;
3339             else if (ds[i].Type == mDNSAddrType_IPv6) v6 = mDNStrue;
3340             if (v4 && v6) return(mDNStrue);
3341         }
3342     return(mDNSfalse);
3343 }
3344 
3345 mDNSlocal void RecordDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 Time, mDNSInterfaceID InterfaceID, mDNSs32 Type)
3346 {
3347     int i, j;
3348 
3349     // See if we have this one in our list somewhere already
3350     for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Type == Type) break;
3351 
3352     // If not, find a slot we can re-use
3353     if (i >= DupSuppressInfoSize)
3354     {
3355         i = 0;
3356         for (j=1; j<DupSuppressInfoSize && ds[i].InterfaceID; j++)
3357             if (!ds[j].InterfaceID || ds[j].Time - ds[i].Time < 0)
3358                 i = j;
3359     }
3360 
3361     // Record the info about this query we saw
3362     ds[i].Time        = Time;
3363     ds[i].InterfaceID = InterfaceID;
3364     ds[i].Type        = Type;
3365 }
3366 
3367 mDNSlocal void mDNSSendWakeOnResolve(mDNS *const m, DNSQuestion *q)
3368 {
3369     int len, i, cnt;
3370     mDNSInterfaceID InterfaceID = q->InterfaceID;
3371     domainname *d = &q->qname;
3372 
3373     // We can't send magic packets without knowing which interface to send it on.
3374     if (InterfaceID == mDNSInterface_Any || LocalOnlyOrP2PInterface(InterfaceID))
3375     {
3376         LogMsg("mDNSSendWakeOnResolve: ERROR!! Invalid InterfaceID %p for question %##s", InterfaceID, q->qname.c);
3377         return;
3378     }
3379 
3380     // Split MAC@IPAddress and pass them separately
3381     len = d->c[0];
3382     cnt = 0;
3383     for (i = 1; i < len; i++)
3384     {
3385         if (d->c[i] == '@')
3386         {
3387             char EthAddr[18];   // ethernet adddress : 12 bytes + 5 ":" + 1 NULL byte
3388             char IPAddr[47];    // Max IP address len: 46 bytes (IPv6) + 1 NULL byte
3389             if (cnt != 5)
3390             {
3391                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, cnt %d", q->qname.c, cnt);
3392                 return;
3393             }
3394             if ((i - 1) > (int) (sizeof(EthAddr) - 1))
3395             {
3396                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, length %d", q->qname.c, i - 1);
3397                 return;
3398             }
3399             if ((len - i) > (int)(sizeof(IPAddr) - 1))
3400             {
3401                 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed IP address %##s, length %d", q->qname.c, len - i);
3402                 return;
3403             }
3404             mDNSPlatformMemCopy(EthAddr, &d->c[1], i - 1);
3405             EthAddr[i - 1] = 0;
3406             mDNSPlatformMemCopy(IPAddr, &d->c[i + 1], len - i);
3407             IPAddr[len - i] = 0;
3408             m->mDNSStats.WakeOnResolves++;
3409             mDNSPlatformSendWakeupPacket(InterfaceID, EthAddr, IPAddr, InitialWakeOnResolveCount - q->WakeOnResolveCount);
3410             return;
3411         }
3412         else if (d->c[i] == ':')
3413             cnt++;
3414     }
3415     LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed WakeOnResolve name %##s", q->qname.c);
3416 }
3417 
3418 
3419 mDNSlocal mDNSBool AccelerateThisQuery(mDNS *const m, DNSQuestion *q)
3420 {
3421     // If more than 90% of the way to the query time, we should unconditionally accelerate it
3422     if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/10))
3423         return(mDNStrue);
3424 
3425     // If half-way to next scheduled query time, only accelerate if it will add less than 512 bytes to the packet
3426     if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/2))
3427     {
3428         // We forecast: qname (n) type (2) class (2)
3429         mDNSu32 forecast = (mDNSu32)DomainNameLength(&q->qname) + 4;
3430         const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3431         const CacheRecord *rr;
3432         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)             // If we have a resource record in our cache,
3433             if (rr->resrec.rdlength <= SmallRecordLimit &&                  // which is small enough to sensibly fit in the packet
3434                 SameNameRecordAnswersQuestion(&rr->resrec, q) &&            // which answers our question
3435                 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow >= 0 &&          // and it is less than half-way to expiry
3436                 rr->NextRequiredQuery - (m->timenow + q->ThisQInterval) > 0) // and we'll ask at least once again before NextRequiredQuery
3437             {
3438                 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3439                 forecast += 12 + rr->resrec.rdestimate;
3440                 if (forecast >= 512) return(mDNSfalse); // If this would add 512 bytes or more to the packet, don't accelerate
3441             }
3442         return(mDNStrue);
3443     }
3444 
3445     return(mDNSfalse);
3446 }
3447 
3448 // How Standard Queries are generated:
3449 // 1. The Question Section contains the question
3450 // 2. The Additional Section contains answers we already know, to suppress duplicate responses
3451 
3452 // How Probe Queries are generated:
3453 // 1. The Question Section contains queries for the name we intend to use, with QType=ANY because
3454 // if some other host is already using *any* records with this name, we want to know about it.
3455 // 2. The Authority Section contains the proposed values we intend to use for one or more
3456 // of our records with that name (analogous to the Update section of DNS Update packets)
3457 // because if some other host is probing at the same time, we each want to know what the other is
3458 // planning, in order to apply the tie-breaking rule to see who gets to use the name and who doesn't.
3459 
3460 mDNSlocal void SendQueries(mDNS *const m)
3461 {
3462     mDNSu32 slot;
3463     CacheGroup *cg;
3464     CacheRecord *cr;
3465     AuthRecord *ar;
3466     int pktcount = 0;
3467     DNSQuestion *q;
3468     // For explanation of maxExistingQuestionInterval logic, see comments for maxExistingAnnounceInterval
3469     mDNSs32 maxExistingQuestionInterval = 0;
3470     const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
3471     CacheRecord *KnownAnswerList = mDNSNULL;
3472 
3473     // 1. If time for a query, work out what we need to do
3474 
3475     // We're expecting to send a query anyway, so see if any expiring cache records are close enough
3476     // to their NextRequiredQuery to be worth batching them together with this one
3477     FORALL_CACHERECORDS(slot, cg, cr)
3478     {
3479         if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
3480         {
3481             if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
3482             {
3483                 debugf("Sending %d%% cache expiration query for %s", 80 + 5 * cr->UnansweredQueries, CRDisplayString(m, cr));
3484                 q = cr->CRActiveQuestion;
3485                 ExpireDupSuppressInfoOnInterface(q->DupSuppress, m->timenow - TicksTTL(cr)/20, cr->resrec.InterfaceID);
3486                 // For uDNS queries (TargetQID non-zero) we adjust LastQTime,
3487                 // and bump UnansweredQueries so that we don't spin trying to send the same cache expiration query repeatedly
3488                 if (q->Target.type)
3489                 {
3490                     q->SendQNow = mDNSInterfaceMark; // If targeted query, mark it
3491                 }
3492                 else if (!mDNSOpaque16IsZero(q->TargetQID))
3493                 {
3494                     q->LastQTime = m->timenow - q->ThisQInterval;
3495                     cr->UnansweredQueries++;
3496                     m->mDNSStats.CacheRefreshQueries++;
3497                 }
3498                 else if (q->SendQNow == mDNSNULL)
3499                 {
3500                     q->SendQNow = cr->resrec.InterfaceID;
3501                 }
3502                 else if (q->SendQNow != cr->resrec.InterfaceID)
3503                 {
3504                     q->SendQNow = mDNSInterfaceMark;
3505                 }
3506 
3507                 // Indicate that this question was marked for sending
3508                 // to update an existing cached answer record.
3509                 // The browse throttling logic below uses this to determine
3510                 // if the query should be sent.
3511                 if (mDNSOpaque16IsZero(q->TargetQID))
3512                     q->CachedAnswerNeedsUpdate = mDNStrue;
3513             }
3514         }
3515     }
3516 
3517     // Scan our list of questions to see which:
3518     //     *WideArea*  queries need to be sent
3519     //     *unicast*   queries need to be sent
3520     //     *multicast* queries we're definitely going to send
3521     if (m->CurrentQuestion)
3522         LogMsg("SendQueries ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3523     m->CurrentQuestion = m->Questions;
3524     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
3525     {
3526         q = m->CurrentQuestion;
3527         if (q->Target.type && (q->SendQNow || TimeToSendThisQuestion(q, m->timenow)))
3528         {
3529             mDNSu8       *qptr        = m->omsg.data;
3530             const mDNSu8 *const limit = m->omsg.data + sizeof(m->omsg.data);
3531 
3532             // 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
3533             if (!q->LocalSocket) q->LocalSocket = mDNSPlatformUDPSocket(zeroIPPort);
3534             if (q->LocalSocket)
3535             {
3536                 InitializeDNSMessage(&m->omsg.h, q->TargetQID, QueryFlags);
3537                 qptr = putQuestion(&m->omsg, qptr, limit, &q->qname, q->qtype, q->qclass);
3538                 mDNSSendDNSMessage(m, &m->omsg, qptr, mDNSInterface_Any, q->LocalSocket, &q->Target, q->TargetPort, mDNSNULL, mDNSNULL, q->UseBackgroundTrafficClass);
3539                 q->ThisQInterval    *= QuestionIntervalStep;
3540             }
3541             if (q->ThisQInterval > MaxQuestionInterval)
3542                 q->ThisQInterval = MaxQuestionInterval;
3543             q->LastQTime         = m->timenow;
3544             q->LastQTxTime       = m->timenow;
3545             q->RecentAnswerPkts  = 0;
3546             q->SendQNow          = mDNSNULL;
3547             q->ExpectUnicastResp = NonZeroTime(m->timenow);
3548         }
3549         else if (mDNSOpaque16IsZero(q->TargetQID) && !q->Target.type && TimeToSendThisQuestion(q, m->timenow))
3550         {
3551             //LogInfo("Time to send %##s (%s) %d", q->qname.c, DNSTypeName(q->qtype), m->timenow - NextQSendTime(q));
3552             q->SendQNow = mDNSInterfaceMark;        // Mark this question for sending on all interfaces
3553             if (maxExistingQuestionInterval < q->ThisQInterval)
3554                 maxExistingQuestionInterval = q->ThisQInterval;
3555         }
3556         // If m->CurrentQuestion wasn't modified out from under us, advance it now
3557         // We can't do this at the start of the loop because uDNS_CheckCurrentQuestion() depends on having
3558         // m->CurrentQuestion point to the right question
3559         if (q == m->CurrentQuestion) m->CurrentQuestion = m->CurrentQuestion->next;
3560     }
3561     while (m->CurrentQuestion)
3562     {
3563         LogInfo("SendQueries question loop 1: Skipping NewQuestion %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3564         m->CurrentQuestion = m->CurrentQuestion->next;
3565     }
3566     m->CurrentQuestion = mDNSNULL;
3567 
3568     // Scan our list of questions
3569     // (a) to see if there are any more that are worth accelerating, and
3570     // (b) to update the state variables for *all* the questions we're going to send
3571     // Note: Don't set NextScheduledQuery until here, because uDNS_CheckCurrentQuestion in the loop above can add new questions to the list,
3572     // which causes NextScheduledQuery to get (incorrectly) set to m->timenow. Setting it here is the right place, because the very
3573     // 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.
3574     m->NextScheduledQuery = m->timenow + FutureTime;
3575     for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3576     {
3577         if (mDNSOpaque16IsZero(q->TargetQID)
3578             && (q->SendQNow || (!q->Target.type && ActiveQuestion(q) && q->ThisQInterval <= maxExistingQuestionInterval && AccelerateThisQuery(m,q))))
3579         {
3580             // If at least halfway to next query time, advance to next interval
3581             // If less than halfway to next query time, then
3582             // treat this as logically a repeat of the last transmission, without advancing the interval
3583             if (m->timenow - (q->LastQTime + (q->ThisQInterval/2)) >= 0)
3584             {
3585                 // If we have reached the answer threshold for this question,
3586                 // don't send it again until MaxQuestionInterval unless:
3587                 //  one of its cached answers needs to be refreshed,
3588                 //  or it's the initial query for a kDNSServiceFlagsThresholdFinder mode browse.
3589                 if (q->BrowseThreshold
3590                     && (q->CurrentAnswers >= q->BrowseThreshold)
3591                     && (q->CachedAnswerNeedsUpdate == mDNSfalse)
3592                     && !((q->flags & kDNSServiceFlagsThresholdFinder) && (q->ThisQInterval == InitialQuestionInterval)))
3593                 {
3594                     q->SendQNow = mDNSNULL;
3595                     q->ThisQInterval = MaxQuestionInterval;
3596                     q->LastQTime = m->timenow;
3597                     q->RequestUnicast = 0;
3598                     LogInfo("SendQueries: (%s) %##s reached threshold of %d answers",
3599                          DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
3600                 }
3601                 else
3602                 {
3603                     // Mark this question for sending on all interfaces
3604                     q->SendQNow = mDNSInterfaceMark;
3605                     q->ThisQInterval *= QuestionIntervalStep;
3606                 }
3607 
3608                 debugf("SendQueries: %##s (%s) next interval %d seconds RequestUnicast = %d",
3609                        q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval / InitialQuestionInterval, q->RequestUnicast);
3610 
3611                 if (q->ThisQInterval > MaxQuestionInterval)
3612                 {
3613                     q->ThisQInterval = MaxQuestionInterval;
3614                 }
3615                 else if (q->CurrentAnswers == 0 && q->ThisQInterval == InitialQuestionInterval * QuestionIntervalStep3 && !q->RequestUnicast &&
3616                          !(RRTypeIsAddressType(q->qtype) && CacheHasAddressTypeForName(m, &q->qname, q->qnamehash)))
3617                 {
3618                     // Generally don't need to log this.
3619                     // It's not especially noteworthy if a query finds no results -- this usually happens for domain
3620                     // enumeration queries in the LL subdomain (e.g. "db._dns-sd._udp.0.0.254.169.in-addr.arpa")
3621                     // and when there simply happen to be no instances of the service the client is looking
3622                     // for (e.g. iTunes is set to look for RAOP devices, and the current network has none).
3623                     debugf("SendQueries: Zero current answers for %##s (%s); will reconfirm antecedents",
3624                            q->qname.c, DNSTypeName(q->qtype));
3625                     // Sending third query, and no answers yet; time to begin doubting the source
3626                     ReconfirmAntecedents(m, &q->qname, q->qnamehash, 0);
3627                 }
3628             }
3629 
3630             // Mark for sending. (If no active interfaces, then don't even try.)
3631             q->SendOnAll = (q->SendQNow == mDNSInterfaceMark);
3632             if (q->SendOnAll)
3633             {
3634                 q->SendQNow  = !intf ? mDNSNULL : (q->InterfaceID) ? q->InterfaceID : intf->InterfaceID;
3635                 q->LastQTime = m->timenow;
3636             }
3637 
3638             // If we recorded a duplicate suppression for this question less than half an interval ago,
3639             // then we consider it recent enough that we don't need to do an identical query ourselves.
3640             ExpireDupSuppressInfo(q->DupSuppress, m->timenow - q->ThisQInterval/2);
3641 
3642             q->LastQTxTime      = m->timenow;
3643             q->RecentAnswerPkts = 0;
3644             if (q->RequestUnicast) q->RequestUnicast--;
3645         }
3646         // For all questions (not just the ones we're sending) check what the next scheduled event will be
3647         // We don't need to consider NewQuestions here because for those we'll set m->NextScheduledQuery in AnswerNewQuestion
3648         SetNextQueryTime(m,q);
3649     }
3650 
3651     // 2. Scan our authoritative RR list to see what probes we might need to send
3652 
3653     m->NextScheduledProbe = m->timenow + FutureTime;
3654 
3655     if (m->CurrentRecord)
3656         LogMsg("SendQueries ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3657     m->CurrentRecord = m->ResourceRecords;
3658     while (m->CurrentRecord)
3659     {
3660         ar = m->CurrentRecord;
3661         m->CurrentRecord = ar->next;
3662         if (!AuthRecord_uDNS(ar) && ar->resrec.RecordType == kDNSRecordTypeUnique)  // For all records that are still probing...
3663         {
3664             // 1. If it's not reached its probe time, just make sure we update m->NextScheduledProbe correctly
3665             if (m->timenow - (ar->LastAPTime + ar->ThisAPInterval) < 0)
3666             {
3667                 SetNextAnnounceProbeTime(m, ar);
3668             }
3669             // 2. else, if it has reached its probe time, mark it for sending and then update m->NextScheduledProbe correctly
3670             else if (ar->ProbeCount)
3671             {
3672                 if (ar->AddressProxy.type == mDNSAddrType_IPv4)
3673                 {
3674                     // There's a problem here. If a host is waking up, and we probe to see if it responds, then
3675                     // it will see those ARP probes as signalling intent to use the address, so it picks a different one.
3676                     // A more benign way to find out if a host is responding to ARPs might be send a standard ARP *request*
3677                     // (using our sender IP address) instead of an ARP *probe* (using all-zero sender IP address).
3678                     // A similar concern may apply to the NDP Probe too. -- SC
3679                     LogSPS("SendQueries ARP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3680                     SendARP(m, 1, ar, &zerov4Addr, &zeroEthAddr, &ar->AddressProxy.ip.v4, &ar->WakeUp.IMAC);
3681                 }
3682                 else if (ar->AddressProxy.type == mDNSAddrType_IPv6)
3683                 {
3684                     LogSPS("SendQueries NDP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3685                     // IPv6 source = zero
3686                     // No target hardware address
3687                     // IPv6 target address is address we're probing
3688                     // Ethernet destination address is Ethernet interface address of the Sleep Proxy client we're probing
3689                     SendNDP(m, NDP_Sol, 0, ar, &zerov6Addr, mDNSNULL, &ar->AddressProxy.ip.v6, &ar->WakeUp.IMAC);
3690                 }
3691                 // Mark for sending. (If no active interfaces, then don't even try.)
3692                 ar->SendRNow   = (!intf || ar->WakeUp.HMAC.l[0]) ? mDNSNULL : ar->resrec.InterfaceID ? ar->resrec.InterfaceID : intf->InterfaceID;
3693                 ar->LastAPTime = m->timenow;
3694                 // When we have a late conflict that resets a record to probing state we use a special marker value greater
3695                 // than DefaultProbeCountForTypeUnique. Here we detect that state and reset ar->ProbeCount back to the right value.
3696                 if (ar->ProbeCount > DefaultProbeCountForTypeUnique)
3697                     ar->ProbeCount = DefaultProbeCountForTypeUnique;
3698                 ar->ProbeCount--;
3699                 SetNextAnnounceProbeTime(m, ar);
3700                 if (ar->ProbeCount == 0)
3701                 {
3702                     // If this is the last probe for this record, then see if we have any matching records
3703                     // on our duplicate list which should similarly have their ProbeCount cleared to zero...
3704                     AuthRecord *r2;
3705                     for (r2 = m->DuplicateRecords; r2; r2=r2->next)
3706                         if (r2->resrec.RecordType == kDNSRecordTypeUnique && RecordIsLocalDuplicate(r2, ar))
3707                             r2->ProbeCount = 0;
3708                     // ... then acknowledge this record to the client.
3709                     // We do this optimistically, just as we're about to send the third probe.
3710                     // This helps clients that both advertise and browse, and want to filter themselves
3711                     // from the browse results list, because it helps ensure that the registration
3712                     // confirmation will be delivered 1/4 second *before* the browse "add" event.
3713                     // A potential downside is that we could deliver a registration confirmation and then find out
3714                     // moments later that there's a name conflict, but applications have to be prepared to handle
3715                     // late conflicts anyway (e.g. on connection of network cable, etc.), so this is nothing new.
3716                     if (!ar->Acknowledged) AcknowledgeRecord(m, ar);
3717                 }
3718             }
3719             // else, if it has now finished probing, move it to state Verified,
3720             // and update m->NextScheduledResponse so it will be announced
3721             else
3722             {
3723                 if (!ar->Acknowledged) AcknowledgeRecord(m, ar);    // Defensive, just in case it got missed somehow
3724                 ar->resrec.RecordType     = kDNSRecordTypeVerified;
3725                 ar->ThisAPInterval = DefaultAnnounceIntervalForTypeUnique;
3726                 ar->LastAPTime     = m->timenow - DefaultAnnounceIntervalForTypeUnique;
3727                 SetNextAnnounceProbeTime(m, ar);
3728             }
3729         }
3730     }
3731     m->CurrentRecord = m->DuplicateRecords;
3732     while (m->CurrentRecord)
3733     {
3734         ar = m->CurrentRecord;
3735         m->CurrentRecord = ar->next;
3736         if (ar->resrec.RecordType == kDNSRecordTypeUnique && ar->ProbeCount == 0 && !ar->Acknowledged)
3737             AcknowledgeRecord(m, ar);
3738     }
3739 
3740     // 3. Now we know which queries and probes we're sending,
3741     // go through our interface list sending the appropriate queries on each interface
3742     while (intf)
3743     {
3744         int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
3745         int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
3746         mDNSu8 *queryptr = m->omsg.data;
3747         mDNSBool useBackgroundTrafficClass = mDNSfalse;    // set if we should use background traffic class
3748 
3749         InitializeDNSMessage(&m->omsg.h, zeroID, QueryFlags);
3750         if (KnownAnswerList) verbosedebugf("SendQueries:   KnownAnswerList set... Will continue from previous packet");
3751         if (!KnownAnswerList)
3752         {
3753             // Start a new known-answer list
3754             CacheRecord **kalistptr = &KnownAnswerList;
3755             mDNSu32 answerforecast = OwnerRecordSpace + TraceRecordSpace;  // Start by assuming we'll need at least enough space to put the Owner+Tracer Option
3756 
3757             // Put query questions in this packet
3758             for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3759             {
3760                 if (mDNSOpaque16IsZero(q->TargetQID) && (q->SendQNow == intf->InterfaceID))
3761                 {
3762                     mDNSBool Suppress = mDNSfalse;
3763                     debugf("SendQueries: %s question for %##s (%s) at %d forecast total %d",
3764                            SuppressOnThisInterface(q->DupSuppress, intf) ? "Suppressing" : "Putting    ",
3765                            q->qname.c, DNSTypeName(q->qtype), queryptr - m->omsg.data, queryptr + answerforecast - m->omsg.data);
3766 
3767                     // If interface is P2P type, verify that query should be sent over it.
3768                     if (!mDNSPlatformValidQuestionForInterface(q, intf))
3769                     {
3770                         q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3771                     }
3772                     // If we're suppressing this question, or we successfully put it, update its SendQNow state
3773                     else if ((Suppress = SuppressOnThisInterface(q->DupSuppress, intf)) ||
3774                         BuildQuestion(m, intf, &m->omsg, &queryptr, q, &kalistptr, &answerforecast))
3775                     {
3776                         // We successfully added the question to the packet. Make sure that
3777                         // we also send the NSEC3 record if required. BuildQuestion accounted for
3778                         // the space.
3779                         //
3780                         // Note: We don't suppress anonymous questions and hence Suppress should always
3781                         // be zero.
3782 
3783                         if (Suppress)
3784                             m->mDNSStats.DupQuerySuppressions++;
3785 
3786                         if (!Suppress && q->AnonInfo)
3787                         {
3788                             debugf("SendQueries: marking for question %##s, Suppress %d", q->qname.c, Suppress);
3789                             q->AnonInfo->SendNow = intf->InterfaceID;
3790                         }
3791                         q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3792                         if (q->WakeOnResolveCount)
3793                         {
3794                             mDNSSendWakeOnResolve(m, q);
3795                             q->WakeOnResolveCount--;
3796                         }
3797 
3798                         // use background traffic class if any included question requires it
3799                         if (q->UseBackgroundTrafficClass)
3800                         {
3801                             useBackgroundTrafficClass = mDNStrue;
3802                         }
3803                     }
3804                 }
3805             }
3806 
3807             // Put probe questions in this packet
3808             for (ar = m->ResourceRecords; ar; ar=ar->next)
3809             {
3810                 if (ar->SendRNow != intf->InterfaceID)
3811                     continue;
3812 
3813                 // If interface is a P2P variant, verify that the probe should be sent over it.
3814                 if (!mDNSPlatformValidRecordForInterface(ar, intf->InterfaceID))
3815                 {
3816                     ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3817                     ar->IncludeInProbe = mDNSfalse;
3818                 }
3819                 else
3820                 {
3821                     mDNSBool ucast = (ar->ProbeCount >= DefaultProbeCountForTypeUnique-1) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3822                     mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3823                     const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.numQuestions ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData);
3824                     // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3825                     mDNSu32 forecast = answerforecast + 12 + ar->resrec.rdestimate;
3826                     mDNSBool putProbe = mDNStrue;
3827                     mDNSu16 qclass = ar->resrec.rrclass | ucbit;
3828 
3829                     {// Determine if this probe question is already in packet's dns message
3830                         const mDNSu8 *questionptr = m->omsg.data;
3831                         DNSQuestion question;
3832                         mDNSu16 n;
3833                         for (n = 0; n < m->omsg.h.numQuestions && questionptr; n++)
3834                         {
3835                             questionptr = getQuestion(&m->omsg, questionptr, limit, mDNSInterface_Any, &question);
3836                             if (questionptr && (question.qtype == kDNSQType_ANY) && (question.qclass == qclass) &&
3837                                 (question.qnamehash == ar->resrec.namehash) && SameDomainName(&question.qname, ar->resrec.name))
3838                             {
3839                                 putProbe = mDNSfalse;  // set to false if already in message
3840                                 break;
3841                             }
3842                         }
3843                     }
3844 
3845                     if (putProbe)
3846                     {
3847                         mDNSu8 *newptr = putQuestion(&m->omsg, queryptr, limit - forecast, ar->resrec.name, kDNSQType_ANY, qclass);
3848                         if (newptr)
3849                         {
3850                             queryptr       = newptr;
3851                             answerforecast = forecast;
3852                             ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3853                             ar->IncludeInProbe = mDNStrue;
3854                             verbosedebugf("SendQueries:   Put Question %##s (%s) probecount %d InterfaceID= %d %d %d",
3855                                       ar->resrec.name->c, DNSTypeName(ar->resrec.rrtype), ar->ProbeCount, ar->resrec.InterfaceID, ar->resrec.rdestimate, answerforecast);
3856                         }
3857                     }
3858                     else
3859                     {
3860                         ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3861                         ar->IncludeInProbe = mDNStrue;
3862                     }
3863                 }
3864             }
3865         }
3866 
3867         // Put our known answer list (either new one from this question or questions, or remainder of old one from last time)
3868         while (KnownAnswerList)
3869         {
3870             CacheRecord *ka = KnownAnswerList;
3871             mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - ka->TimeRcvd)) / mDNSPlatformOneSecond;
3872             mDNSu8 *newptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAnswers, &ka->resrec, ka->resrec.rroriginalttl - SecsSinceRcvd,
3873                                                            m->omsg.data + NormalMaxDNSMessageData - OwnerRecordSpace - TraceRecordSpace);
3874             if (newptr)
3875             {
3876                 verbosedebugf("SendQueries:   Put %##s (%s) at %d - %d",
3877                               ka->resrec.name->c, DNSTypeName(ka->resrec.rrtype), queryptr - m->omsg.data, newptr - m->omsg.data);
3878                 queryptr = newptr;
3879                 KnownAnswerList = ka->NextInKAList;
3880                 ka->NextInKAList = mDNSNULL;
3881             }
3882             else
3883             {
3884                 // If we ran out of space and we have more than one question in the packet, that's an error --
3885                 // we shouldn't have put more than one question if there was a risk of us running out of space.
3886                 if (m->omsg.h.numQuestions > 1)
3887                     LogMsg("SendQueries:   Put %d answers; No more space for known answers", m->omsg.h.numAnswers);
3888                 m->omsg.h.flags.b[0] |= kDNSFlag0_TC;
3889                 break;
3890             }
3891         }
3892 
3893         for (ar = m->ResourceRecords; ar; ar=ar->next)
3894         {
3895             if (ar->IncludeInProbe)
3896             {
3897                 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, &ar->resrec);
3898                 ar->IncludeInProbe = mDNSfalse;
3899                 if (newptr) queryptr = newptr;
3900                 else LogMsg("SendQueries:   How did we fail to have space for the Update record %s", ARDisplayString(m,ar));
3901             }
3902         }
3903 
3904         for (q = m->Questions; q; q = q->next)
3905         {
3906             if (q->AnonInfo && q->AnonInfo->SendNow == intf->InterfaceID)
3907             {
3908                 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, q->AnonInfo->nsec3RR);
3909                 if (newptr)
3910                 {
3911                     debugf("SendQueries: Added NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3912                     queryptr = newptr;
3913                 }
3914                 else
3915                 {
3916                     LogMsg("SendQueries: ERROR!! Cannot add NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3917                 }
3918                 q->AnonInfo->SendNow = mDNSNULL;
3919             }
3920         }
3921 
3922         if (queryptr > m->omsg.data)
3923         {
3924             // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
3925             if (OwnerRecordSpace || TraceRecordSpace)
3926             {
3927                 AuthRecord opt;
3928                 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
3929                 opt.resrec.rrclass    = NormalMaxDNSMessageData;
3930                 opt.resrec.rdlength   = sizeof(rdataOPT);
3931                 opt.resrec.rdestimate = sizeof(rdataOPT);
3932                 if (OwnerRecordSpace && TraceRecordSpace)
3933                 {
3934                     opt.resrec.rdlength   += sizeof(rdataOPT);  // Two options in this OPT record
3935                     opt.resrec.rdestimate += sizeof(rdataOPT);
3936                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3937                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
3938                 }
3939                 else if (OwnerRecordSpace)
3940                 {
3941                     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3942                 }
3943                 else if (TraceRecordSpace)
3944                 {
3945                     SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
3946                 }
3947                 queryptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAdditionals,
3948                                                          &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
3949                 if (!queryptr)
3950                 {
3951                     LogMsg("SendQueries: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
3952                            m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3953                 }
3954                 if (queryptr > m->omsg.data + NormalMaxDNSMessageData)
3955                 {
3956                     if (m->omsg.h.numQuestions != 1 || m->omsg.h.numAnswers != 0 || m->omsg.h.numAuthorities != 1 || m->omsg.h.numAdditionals != 1)
3957                         LogMsg("SendQueries: Why did we generate oversized packet with %s %s OPT record %p %p %p (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "",
3958                                 TraceRecordSpace ? "TRACER" : "", m->omsg.data, m->omsg.data + NormalMaxDNSMessageData, queryptr, m->omsg.h.numQuestions, m->omsg.h.numAnswers,
3959                                 m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3960                 }
3961             }
3962 
3963             if ((m->omsg.h.flags.b[0] & kDNSFlag0_TC) && m->omsg.h.numQuestions > 1)
3964                 LogMsg("SendQueries: Should not have more than one question (%d) in a truncated packet", m->omsg.h.numQuestions);
3965             debugf("SendQueries:   Sending %d Question%s %d Answer%s %d Update%s on %p",
3966                    m->omsg.h.numQuestions,   m->omsg.h.numQuestions   == 1 ? "" : "s",
3967                    m->omsg.h.numAnswers,     m->omsg.h.numAnswers     == 1 ? "" : "s",
3968                    m->omsg.h.numAuthorities, m->omsg.h.numAuthorities == 1 ? "" : "s", intf->InterfaceID);
3969             if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3970             if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3971             if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
3972             if (++pktcount >= 1000)
3973             { LogMsg("SendQueries exceeded loop limit %d: giving up", pktcount); break; }
3974             // There might be more records left in the known answer list, or more questions to send
3975             // on this interface, so go around one more time and try again.
3976         }
3977         else    // Nothing more to send on this interface; go to next
3978         {
3979             const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3980             #if MDNS_DEBUGMSGS && 0
3981             const char *const msg = next ? "SendQueries:   Nothing more on %p; moving to %p" : "SendQueries:   Nothing more on %p";
3982             debugf(msg, intf, next);
3983             #endif
3984             intf = next;
3985         }
3986     }
3987 
3988     // 4. Final housekeeping
3989 
3990     // 4a. Debugging check: Make sure we announced all our records
3991     for (ar = m->ResourceRecords; ar; ar=ar->next)
3992         if (ar->SendRNow)
3993         {
3994             if (ar->ARType != AuthRecordLocalOnly && ar->ARType != AuthRecordP2P)
3995                 LogInfo("SendQueries: No active interface %d to send probe: %d %s",
3996                     (uint32_t)ar->SendRNow, (uint32_t)ar->resrec.InterfaceID, ARDisplayString(m, ar));
3997             ar->SendRNow = mDNSNULL;
3998         }
3999 
4000     // 4b. When we have lingering cache records that we're keeping around for a few seconds in the hope
4001     // that their interface which went away might come back again, the logic will want to send queries
4002     // for those records, but we can't because their interface isn't here any more, so to keep the
4003     // state machine ticking over we just pretend we did so.
4004     // If the interface does not come back in time, the cache record will expire naturally
4005     FORALL_CACHERECORDS(slot, cg, cr)
4006     {
4007         if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
4008         {
4009             if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
4010             {
4011                 cr->UnansweredQueries++;
4012                 cr->CRActiveQuestion->SendQNow = mDNSNULL;
4013                 SetNextCacheCheckTimeForRecord(m, cr);
4014             }
4015         }
4016     }
4017 
4018     // 4c. Debugging check: Make sure we sent all our planned questions
4019     // Do this AFTER the lingering cache records check above, because that will prevent spurious warnings for questions
4020     // we legitimately couldn't send because the interface is no longer available
4021     for (q = m->Questions; q; q=q->next)
4022     {
4023         if (q->SendQNow)
4024         {
4025             DNSQuestion *x;
4026             for (x = m->NewQuestions; x; x=x->next) if (x == q) break;  // Check if this question is a NewQuestion
4027             // There will not be an active interface for questions applied to mDNSInterface_BLE
4028             // so don't log the warning in that case.
4029             if (q->InterfaceID != mDNSInterface_BLE)
4030                 LogInfo("SendQueries: No active interface %d to send %s question: %d %##s (%s)",
4031                     (uint32_t)q->SendQNow, x ? "new" : "old", (uint32_t)q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
4032             q->SendQNow = mDNSNULL;
4033         }
4034         q->CachedAnswerNeedsUpdate = mDNSfalse;
4035     }
4036 }
4037 
4038 mDNSlocal void SendWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *EthAddr, mDNSOpaque48 *password, mDNSBool unicastOnly)
4039 {
4040     int i, j;
4041 
4042     mDNSu8 *ptr = m->omsg.data;
4043     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
4044     if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found", InterfaceID); return; }
4045 
4046     // 0x00 Destination address
4047     for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4048 
4049     // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
4050     for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
4051 
4052     // 0x0C Ethertype (0x0842)
4053     *ptr++ = 0x08;
4054     *ptr++ = 0x42;
4055 
4056     // 0x0E Wakeup sync sequence
4057     for (i=0; i<6; i++) *ptr++ = 0xFF;
4058 
4059     // 0x14 Wakeup data
4060     for (j=0; j<16; j++) for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4061 
4062     // 0x74 Password
4063     for (i=0; i<6; i++) *ptr++ = password->b[i];
4064 
4065     mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4066 
4067     if (!unicastOnly)
4068     {
4069         // For Ethernet switches that don't flood-foward packets with unknown unicast destination MAC addresses,
4070         // broadcast is the only reliable way to get a wakeup packet to the intended target machine.
4071         // For 802.11 WPA networks, where a sleeping target machine may have missed a broadcast/multicast
4072         // key rotation, unicast is the only way to get a wakeup packet to the intended target machine.
4073         // So, we send one of each, unicast first, then broadcast second.
4074         for (i=0; i<6; i++) m->omsg.data[i] = 0xFF;
4075         mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4076     }
4077 }
4078 
4079 // ***************************************************************************
4080 #if COMPILER_LIKES_PRAGMA_MARK
4081 #pragma mark -
4082 #pragma mark - RR List Management & Task Management
4083 #endif
4084 
4085 // Whenever a question is answered, reset its state so that we don't query
4086 // the network repeatedly. This happens first time when we answer the question and
4087 // and later when we refresh the cache.
4088 mDNSlocal void ResetQuestionState(mDNS *const m, DNSQuestion *q)
4089 {
4090     q->LastQTime        = m->timenow;
4091     q->LastQTxTime      = m->timenow;
4092     q->RecentAnswerPkts = 0;
4093     q->ThisQInterval    = MaxQuestionInterval;
4094     q->RequestUnicast   = 0;
4095     // Reset unansweredQueries so that we don't penalize this server later when we
4096     // start sending queries when the cache expires.
4097     q->unansweredQueries = 0;
4098     debugf("ResetQuestionState: Set MaxQuestionInterval for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4099 }
4100 
4101 // Note: AnswerCurrentQuestionWithResourceRecord can call a user callback, which may change the record list and/or question list.
4102 // Any code walking either list must use the m->CurrentQuestion (and possibly m->CurrentRecord) mechanism to protect against this.
4103 // In fact, to enforce this, the routine will *only* answer the question currently pointed to by m->CurrentQuestion,
4104 // which will be auto-advanced (possibly to NULL) if the client callback cancels the question.
4105 mDNSexport void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord)
4106 {
4107     DNSQuestion *const q = m->CurrentQuestion;
4108     const mDNSBool followcname = FollowCNAME(q, &rr->resrec, AddRecord);
4109 
4110     verbosedebugf("AnswerCurrentQuestionWithResourceRecord:%4lu %s TTL %d %s",
4111                   q->CurrentAnswers, AddRecord ? "Add" : "Rmv", rr->resrec.rroriginalttl, CRDisplayString(m, rr));
4112 
4113     // When the response for the question was validated, the entire rrset was validated. If we deliver
4114     // a RMV for a single record in the rrset, we invalidate the response. If we deliver another add
4115     // in the future, we will do the revalidation again.
4116     //
4117     // Also, if we deliver an ADD for a negative cache record and it has no NSEC/NSEC3, the ValidationStatus needs
4118     // to be reset. This happens normally when we deliver a "secure" negative response followed by an insecure
4119     // negative response which can happen e.g., when disconnecting from network that leads to a negative response
4120     // due to no DNS servers. As we don't deliver RMVs for negative responses that were delivered before, we need
4121     // to do it on the next ADD of a negative cache record. This ADD could be the result of a timeout, no DNS servers
4122     // etc. in which case we need to reset the state to make sure we don't deliver them as secure. If this is
4123     // a real negative response, we would reset the state here and validate the results at the end of this function.
4124     // or the real response again if we purge the cache.
4125     if (q->ValidationRequired && ((AddRecord == QC_rmv) ||
4126         (rr->resrec.RecordType == kDNSRecordTypePacketNegative && (AddRecord == QC_add))))
4127     {
4128         q->ValidationStatus = 0;
4129         q->ValidationState = DNSSECValRequired;
4130     }
4131 
4132     // Normally we don't send out the unicast query if we have answered using our local only auth records e.g., /etc/hosts.
4133     // But if the query for "A" record has a local answer but query for "AAAA" record has no local answer, we might
4134     // send the AAAA query out which will come back with CNAME and will also answer the "A" query. To prevent that,
4135     // we check to see if that query already has a unique local answer.
4136     if (q->LOAddressAnswers)
4137     {
4138         LogInfo("AnswerCurrentQuestionWithResourceRecord: Question %p %##s (%s) not answering with record %s due to "
4139                 "LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr),
4140                 q->LOAddressAnswers);
4141         return;
4142     }
4143 
4144     if (QuerySuppressed(q))
4145     {
4146         // If the query is suppressed, then we don't want to answer from the cache. But if this query is
4147         // supposed to time out, we still want to callback the clients. We do this only for TimeoutQuestions
4148         // that are timing out, which we know are answered with negative cache record when timing out.
4149         if (!q->TimeoutQuestion || rr->resrec.RecordType != kDNSRecordTypePacketNegative || (m->timenow - q->StopTime < 0))
4150             return;
4151     }
4152 
4153 #if AWD_METRICS
4154     if ((AddRecord == QC_add) && Question_uDNS(q) && !followcname)
4155     {
4156         const domainname *  queryName;
4157         mDNSu32             responseLatencyMs;
4158         mDNSBool            isForCellular;
4159 
4160         queryName = q->metrics.originalQName ? q->metrics.originalQName : &q->qname;
4161         isForCellular = (q->qDNSServer && q->qDNSServer->cellIntf);
4162         if (!q->metrics.answered)
4163         {
4164             if (q->metrics.querySendCount > 0)
4165             {
4166                 responseLatencyMs = ((m->timenow - q->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
4167             }
4168             else
4169             {
4170                 responseLatencyMs = 0;
4171             }
4172 
4173             MetricsUpdateUDNSQueryStats(queryName, q->qtype, &rr->resrec, q->metrics.querySendCount, responseLatencyMs, isForCellular);
4174             q->metrics.answered = mDNStrue;
4175         }
4176         if (q->metrics.querySendCount > 0)
4177         {
4178             MetricsUpdateUDNSResolveStats(queryName, &rr->resrec, isForCellular);
4179         }
4180     }
4181 #endif
4182     // Note: Use caution here. In the case of records with rr->DelayDelivery set, AnswerCurrentQuestionWithResourceRecord(... mDNStrue)
4183     // may be called twice, once when the record is received, and again when it's time to notify local clients.
4184     // If any counters or similar are added here, care must be taken to ensure that they are not double-incremented by this.
4185 
4186     rr->LastUsed = m->timenow;
4187     if (AddRecord == QC_add && !q->DuplicateOf && rr->CRActiveQuestion != q)
4188     {
4189         if (!rr->CRActiveQuestion) m->rrcache_active++; // If not previously active, increment rrcache_active count
4190         debugf("AnswerCurrentQuestionWithResourceRecord: Updating CRActiveQuestion from %p to %p for cache record %s, CurrentAnswer %d",
4191                rr->CRActiveQuestion, q, CRDisplayString(m,rr), q->CurrentAnswers);
4192         rr->CRActiveQuestion = q;                       // We know q is non-null
4193         SetNextCacheCheckTimeForRecord(m, rr);
4194     }
4195 
4196     // If this is:
4197     // (a) a no-cache add, where we've already done at least one 'QM' query, or
4198     // (b) a normal add, where we have at least one unique-type answer,
4199     // then there's no need to keep polling the network.
4200     // (If we have an answer in the cache, then we'll automatically ask again in time to stop it expiring.)
4201     // We do this for mDNS questions and uDNS one-shot questions, but not for
4202     // uDNS LongLived questions, because that would mess up our LLQ lease renewal timing.
4203     if ((AddRecord == QC_addnocache && !q->RequestUnicast) ||
4204         (AddRecord == QC_add && (q->ExpectUnique || (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))))
4205         if (ActiveQuestion(q) && (mDNSOpaque16IsZero(q->TargetQID) || !q->LongLived))
4206         {
4207             ResetQuestionState(m, q);
4208         }
4209 
4210     if (rr->DelayDelivery) return;      // We'll come back later when CacheRecordDeferredAdd() calls us
4211 
4212 #if USE_DNS64
4213     // If DNS64StateMachine() returns true, then the question was restarted as a different question, so return.
4214     if (!mDNSOpaque16IsZero(q->TargetQID) && DNS64StateMachine(m, q, &rr->resrec, AddRecord)) return;
4215 #endif
4216 
4217 #ifdef USE_LIBIDN
4218     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative)  // If negative answer, check if we need to try Punycode conversion
4219     {
4220         domainname newname;
4221         if (PerformNextPunycodeConversion(q, &newname))         // Itertative Punycode conversion succeeded, so reissue question with new name
4222         {
4223             UDPSocket *const sock = q->LocalSocket;             // Save old socket and transaction ID
4224             const mDNSOpaque16 id = q->TargetQID;
4225             q->LocalSocket = mDNSNULL;
4226             mDNS_StopQuery_internal(m, q);                      // Stop old query
4227             AssignDomainName(&q->qname, &newname);              // Update qname
4228             q->qnamehash = DomainNameHashValue(&q->qname);      // and namehash
4229             mDNS_StartQuery_internal(m, q);                     // Start new query
4230 
4231             if (sock)                                           // Transplant saved socket, if appropriate
4232             {
4233                 if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
4234                 else { q->LocalSocket = sock; q->TargetQID = id; }
4235             }
4236             return;                                             // All done for now; wait until we get the next answer
4237         }
4238     }
4239 #endif // USE_LIBIDN
4240 
4241     // Only deliver negative answers if client has explicitly requested them except when we are forcing a negative response
4242     // for the purpose of retrying search domains/timeout OR the question is suppressed
4243     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative || (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype)))
4244         if (!AddRecord || (AddRecord != QC_suppressed && AddRecord != QC_forceresponse && !q->ReturnIntermed)) return;
4245 
4246     // For CNAME results to non-CNAME questions, only inform the client if they explicitly requested that
4247     if (q->QuestionCallback && !q->NoAnswer && (!followcname || q->ReturnIntermed))
4248     {
4249         mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
4250         if (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype))
4251         {
4252             CacheRecord neg;
4253             MakeNegativeCacheRecord(m, &neg, &q->qname, q->qnamehash, q->qtype, q->qclass, 1, rr->resrec.InterfaceID, q->qDNSServer);
4254             q->QuestionCallback(m, q, &neg.resrec, AddRecord);
4255         }
4256         else
4257         {
4258 #if USE_DNS64
4259             if (DNS64ShouldAnswerQuestion(q, &rr->resrec))
4260             {
4261                 DNS64AnswerQuestion(m, q, &rr->resrec, AddRecord);
4262             }
4263             else
4264 #endif
4265             {
4266                 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
4267             }
4268         }
4269         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
4270     }
4271     // If this is an "Add" operation and this question needs validation, validate the response.
4272     // In the case of negative responses, extra care should be taken. Negative cache records are
4273     // used for many purposes. For example,
4274     //
4275     // 1) Suppressing questions (SuppressUnusable)
4276     // 2) Timeout questions
4277     // 3) The name does not exist
4278     // 4) No DNS servers are available and we need a quick response for the application
4279     //
4280     // (1) and (2) are handled by "QC_add" check as AddRecord would be "QC_forceresponse" or "QC_suppressed"
4281     // in that case. For (3), it is possible that we don't get nsecs back but we still need to call
4282     // VerifySignature so that we can deliver the appropriate DNSSEC result. There is no point in verifying
4283     // signature for (4) and hence the explicit check for q->qDNSServer.
4284     //
4285     if (m->CurrentQuestion == q && (AddRecord == QC_add) && !q->ValidatingResponse && q->ValidationRequired &&
4286         q->ValidationState == DNSSECValRequired && q->qDNSServer)
4287     {
4288         q->ValidationState = DNSSECValInProgress;
4289         // Treat it as callback call as that's what dnssec code expects
4290         mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
4291         VerifySignature(m, mDNSNULL, q);
4292         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
4293         return;
4294     }
4295 
4296     // Note: Proceed with caution here because client callback function is allowed to do anything,
4297     // including starting/stopping queries, registering/deregistering records, etc.
4298     //
4299     // If we get a CNAME back while we are validating the response (i.e., CNAME for DS, DNSKEY, RRSIG),
4300     // don't follow them. If it is a ValidationRequired question, wait for the CNAME to be validated
4301     // first before following it
4302     if ((m->CurrentQuestion == q) && followcname && !ValidatingQuestion(q))
4303         AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
4304 }
4305 
4306 mDNSlocal void CacheRecordDeferredAdd(mDNS *const m, CacheRecord *rr)
4307 {
4308     rr->DelayDelivery = 0;
4309     if (m->CurrentQuestion)
4310         LogMsg("CacheRecordDeferredAdd ERROR m->CurrentQuestion already set: %##s (%s)",
4311                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4312     m->CurrentQuestion = m->Questions;
4313     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4314     {
4315         DNSQuestion *q = m->CurrentQuestion;
4316         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4317             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4318         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4319             m->CurrentQuestion = q->next;
4320     }
4321     m->CurrentQuestion = mDNSNULL;
4322 }
4323 
4324 mDNSlocal mDNSs32 CheckForSoonToExpireRecords(mDNS *const m, const domainname *const name, const mDNSu32 namehash, mDNSBool *purge)
4325 {
4326     const mDNSs32 threshhold = m->timenow + mDNSPlatformOneSecond;  // See if there are any records expiring within one second
4327     const mDNSs32 start      = m->timenow - 0x10000000;
4328     mDNSs32 delay = start;
4329     CacheGroup *cg = CacheGroupForName(m, namehash, name);
4330     const CacheRecord *rr;
4331 
4332     if (purge)
4333         *purge = mDNSfalse;
4334     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4335     {
4336         // If there are records that will expire soon, there are cases that need delayed
4337         // delivery of events:
4338         //
4339         // 1) A new cache entry is about to be added as a replacement. The caller needs to
4340         //    deliver a RMV (for the current old entry) followed by ADD (for the new entry).
4341         //    It needs to schedule the timer for the next cache expiry (ScheduleNextCacheCheckTime),
4342         //    so that the cache entry can be purged (purging causes the RMV followed by ADD)
4343         //
4344         // 2) A new question is about to be answered and the caller needs to know whether it's
4345         //    scheduling should be delayed so that the question is not answered with this record.
4346         //    Instead of delivering an ADD (old entry) followed by RMV (old entry) and another ADD
4347         //    (new entry), a single ADD can be delivered by delaying the scheduling of the question
4348         //    immediately.
4349         //
4350         // When the unicast cache record is created, it's TTL has been extended beyond its value
4351         // given in the resource record (See RRAdjustTTL). If it is in the "extended" time, the
4352         // cache is already expired and we set "purge" to indicate that. When "purge" is set, the
4353         // return value of the function should be ignored by the callers.
4354         //
4355         // Note: For case (1), "purge" argument is NULL and hence the following checks are skipped.
4356         // It is okay to skip in that case because the cache records have been set to expire almost
4357         // immediately and the extended time does not apply.
4358         //
4359         // Also, if there is already an active question we don't try to optimize as purging the cache
4360         // would end up delivering RMV for the active question and hence we avoid that.
4361 
4362         if (purge && !rr->resrec.InterfaceID && !rr->CRActiveQuestion && rr->resrec.rroriginalttl)
4363         {
4364             mDNSu32 uTTL = RRUnadjustedTTL(rr->resrec.rroriginalttl);
4365             if (m->timenow - (rr->TimeRcvd + ((mDNSs32)uTTL * mDNSPlatformOneSecond)) >= 0)
4366             {
4367                 LogInfo("CheckForSoonToExpireRecords: %s: rroriginalttl %u, unadjustedTTL %u, currentTTL %u",
4368                     CRDisplayString(m, rr), rr->resrec.rroriginalttl, uTTL, (m->timenow - rr->TimeRcvd)/mDNSPlatformOneSecond);
4369                 *purge = mDNStrue;
4370                 continue;
4371             }
4372         }
4373         if (threshhold - RRExpireTime(rr) >= 0)     // If we have records about to expire within a second
4374         {
4375             if (delay - RRExpireTime(rr) < 0)       // then delay until after they've been deleted
4376                 delay = RRExpireTime(rr);
4377         }
4378     }
4379     if (delay - start > 0)
4380         return(NonZeroTime(delay));
4381     else
4382         return(0);
4383 }
4384 
4385 // CacheRecordAdd is only called from CreateNewCacheEntry, *never* directly as a result of a client API call.
4386 // If new questions are created as a result of invoking client callbacks, they will be added to
4387 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4388 // rr is a new CacheRecord just received into our cache
4389 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4390 // Note: CacheRecordAdd calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4391 // which may change the record list and/or question list.
4392 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4393 mDNSlocal void CacheRecordAdd(mDNS *const m, CacheRecord *rr)
4394 {
4395     DNSQuestion *q;
4396 
4397     // We stop when we get to NewQuestions -- if we increment their CurrentAnswers/LargeAnswers/UniqueAnswers
4398     // counters here we'll end up double-incrementing them when we do it again in AnswerNewQuestion().
4399     for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
4400     {
4401         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4402         {
4403             // If this question is one that's actively sending queries, and it's received ten answers within one
4404             // second of sending the last query packet, then that indicates some radical network topology change,
4405             // so reset its exponential backoff back to the start. We must be at least at the eight-second interval
4406             // to do this. If we're at the four-second interval, or less, there's not much benefit accelerating
4407             // because we will anyway send another query within a few seconds. The first reset query is sent out
4408             // randomized over the next four seconds to reduce possible synchronization between machines.
4409             if (q->LastAnswerPktNum != m->PktNum)
4410             {
4411                 q->LastAnswerPktNum = m->PktNum;
4412                 if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q) && ++q->RecentAnswerPkts >= 10 &&
4413                     q->ThisQInterval > InitialQuestionInterval * QuestionIntervalStep3 && m->timenow - q->LastQTxTime < mDNSPlatformOneSecond)
4414                 {
4415                     LogMsg("CacheRecordAdd: %##s (%s) got immediate answer burst (%d); restarting exponential backoff sequence (%d)",
4416                            q->qname.c, DNSTypeName(q->qtype), q->RecentAnswerPkts, q->ThisQInterval);
4417                     q->LastQTime      = m->timenow - InitialQuestionInterval + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*4);
4418                     q->ThisQInterval  = InitialQuestionInterval;
4419                     SetNextQueryTime(m,q);
4420                 }
4421             }
4422             verbosedebugf("CacheRecordAdd %p %##s (%s) %lu %#a:%d question %p", rr, rr->resrec.name->c,
4423                           DNSTypeName(rr->resrec.rrtype), rr->resrec.rroriginalttl, rr->resrec.rDNSServer ?
4424                           &rr->resrec.rDNSServer->addr : mDNSNULL, mDNSVal16(rr->resrec.rDNSServer ?
4425                                                                              rr->resrec.rDNSServer->port : zeroIPPort), q);
4426             q->CurrentAnswers++;
4427 
4428             q->unansweredQueries = 0;
4429             if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4430             if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4431             if (q->CurrentAnswers > 4000)
4432             {
4433                 static int msgcount = 0;
4434                 if (msgcount++ < 10)
4435                     LogMsg("CacheRecordAdd: %##s (%s) has %d answers; shedding records to resist DOS attack",
4436                            q->qname.c, DNSTypeName(q->qtype), q->CurrentAnswers);
4437                 rr->resrec.rroriginalttl = 0;
4438                 rr->UnansweredQueries = MaxUnansweredQueries;
4439             }
4440         }
4441     }
4442 
4443     if (!rr->DelayDelivery)
4444     {
4445         if (m->CurrentQuestion)
4446             LogMsg("CacheRecordAdd ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4447         m->CurrentQuestion = m->Questions;
4448         while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4449         {
4450             q = m->CurrentQuestion;
4451             if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4452                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4453             if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4454                 m->CurrentQuestion = q->next;
4455         }
4456         m->CurrentQuestion = mDNSNULL;
4457     }
4458 
4459     SetNextCacheCheckTimeForRecord(m, rr);
4460 }
4461 
4462 // NoCacheAnswer is only called from mDNSCoreReceiveResponse, *never* directly as a result of a client API call.
4463 // If new questions are created as a result of invoking client callbacks, they will be added to
4464 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4465 // rr is a new CacheRecord just received from the wire (kDNSRecordTypePacketAns/AnsUnique/Add/AddUnique)
4466 // but we don't have any place to cache it. We'll deliver question 'add' events now, but we won't have any
4467 // way to deliver 'remove' events in future, nor will we be able to include this in known-answer lists,
4468 // so we immediately bump ThisQInterval up to MaxQuestionInterval to avoid pounding the network.
4469 // Note: NoCacheAnswer calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4470 // which may change the record list and/or question list.
4471 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4472 mDNSlocal void NoCacheAnswer(mDNS *const m, CacheRecord *rr)
4473 {
4474     LogMsg("No cache space: Delivering non-cached result for %##s", m->rec.r.resrec.name->c);
4475     if (m->CurrentQuestion)
4476         LogMsg("NoCacheAnswer ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4477     m->CurrentQuestion = m->Questions;
4478     // We do this for *all* questions, not stopping when we get to m->NewQuestions,
4479     // since we're not caching the record and we'll get no opportunity to do this later
4480     while (m->CurrentQuestion)
4481     {
4482         DNSQuestion *q = m->CurrentQuestion;
4483         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4484             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_addnocache);  // QC_addnocache means "don't expect remove events for this"
4485         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4486             m->CurrentQuestion = q->next;
4487     }
4488     m->CurrentQuestion = mDNSNULL;
4489 }
4490 
4491 // CacheRecordRmv is only called from CheckCacheExpiration, which is called from mDNS_Execute.
4492 // Note that CacheRecordRmv is *only* called for records that are referenced by at least one active question.
4493 // If new questions are created as a result of invoking client callbacks, they will be added to
4494 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4495 // rr is an existing cache CacheRecord that just expired and is being deleted
4496 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4497 // Note: CacheRecordRmv calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4498 // which may change the record list and/or question list.
4499 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4500 mDNSlocal void CacheRecordRmv(mDNS *const m, CacheRecord *rr)
4501 {
4502     if (m->CurrentQuestion)
4503         LogMsg("CacheRecordRmv ERROR m->CurrentQuestion already set: %##s (%s)",
4504                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4505     m->CurrentQuestion = m->Questions;
4506 
4507     // We stop when we get to NewQuestions -- for new questions their CurrentAnswers/LargeAnswers/UniqueAnswers counters
4508     // will all still be zero because we haven't yet gone through the cache counting how many answers we have for them.
4509     while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4510     {
4511         DNSQuestion *q = m->CurrentQuestion;
4512         // When a question enters suppressed state, we generate RMV events and generate a negative
4513         // response. A cache may be present that answers this question e.g., cache entry generated
4514         // before the question became suppressed. We need to skip the suppressed questions here as
4515         // the RMV event has already been generated.
4516         if (!QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
4517         {
4518             verbosedebugf("CacheRecordRmv %p %s", rr, CRDisplayString(m, rr));
4519             q->FlappingInterface1 = mDNSNULL;
4520             q->FlappingInterface2 = mDNSNULL;
4521 
4522             if (q->CurrentAnswers == 0)
4523                 LogMsg("CacheRecordRmv ERROR!!: How can CurrentAnswers already be zero for %p %##s (%s) DNSServer %#a:%d",
4524                        q, q->qname.c, DNSTypeName(q->qtype), q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL,
4525                        mDNSVal16(q->qDNSServer ? q->qDNSServer->port : zeroIPPort));
4526             else
4527             {
4528                 q->CurrentAnswers--;
4529                 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
4530                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
4531             }
4532 
4533             // If we have dropped below the answer threshold for this mDNS question,
4534             // restart the queries at InitialQuestionInterval.
4535             if (mDNSOpaque16IsZero(q->TargetQID) && (q->BrowseThreshold > 0) && (q->CurrentAnswers < q->BrowseThreshold))
4536             {
4537                 q->ThisQInterval = InitialQuestionInterval;
4538                 q->LastQTime     = m->timenow - q->ThisQInterval;
4539                 SetNextQueryTime(m,q);
4540                 LogInfo("CacheRecordRmv: (%s) %##s dropped below threshold of %d answers",
4541                     DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
4542             }
4543             if (rr->resrec.rdata->MaxRDLength) // Never generate "remove" events for negative results
4544             {
4545                 if (q->CurrentAnswers == 0)
4546                 {
4547                     LogInfo("CacheRecordRmv: Last answer for %##s (%s) expired from cache; will reconfirm antecedents",
4548                             q->qname.c, DNSTypeName(q->qtype));
4549                     ReconfirmAntecedents(m, &q->qname, q->qnamehash, 0);
4550                 }
4551                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
4552             }
4553         }
4554         if (m->CurrentQuestion == q)    // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4555             m->CurrentQuestion = q->next;
4556     }
4557     m->CurrentQuestion = mDNSNULL;
4558 }
4559 
4560 mDNSlocal void ReleaseCacheEntity(mDNS *const m, CacheEntity *e)
4561 {
4562 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING >= 1
4563     unsigned int i;
4564     for (i=0; i<sizeof(*e); i++) ((char*)e)[i] = 0xFF;
4565 #endif
4566     e->next = m->rrcache_free;
4567     m->rrcache_free = e;
4568     m->rrcache_totalused--;
4569 }
4570 
4571 mDNSlocal void ReleaseCacheGroup(mDNS *const m, CacheGroup **cp)
4572 {
4573     CacheEntity *e = (CacheEntity *)(*cp);
4574     //LogMsg("ReleaseCacheGroup:  Releasing CacheGroup for %p, %##s", (*cp)->name->c, (*cp)->name->c);
4575     if ((*cp)->rrcache_tail != &(*cp)->members)
4576         LogMsg("ERROR: (*cp)->members == mDNSNULL but (*cp)->rrcache_tail != &(*cp)->members)");
4577     //if ((*cp)->name != (domainname*)((*cp)->namestorage))
4578     //  LogMsg("ReleaseCacheGroup: %##s, %p %p", (*cp)->name->c, (*cp)->name, (domainname*)((*cp)->namestorage));
4579     if ((*cp)->name != (domainname*)((*cp)->namestorage)) mDNSPlatformMemFree((*cp)->name);
4580     (*cp)->name = mDNSNULL;
4581     *cp = (*cp)->next;          // Cut record from list
4582     ReleaseCacheEntity(m, e);
4583 }
4584 
4585 mDNSlocal void ReleaseAdditionalCacheRecords(mDNS *const m, CacheRecord **rp)
4586 {
4587     while (*rp)
4588     {
4589         CacheRecord *rr = *rp;
4590         *rp = (*rp)->next;          // Cut record from list
4591         if (rr->resrec.rdata && rr->resrec.rdata != (RData*)&rr->smallrdatastorage)
4592         {
4593             mDNSPlatformMemFree(rr->resrec.rdata);
4594             rr->resrec.rdata = mDNSNULL;
4595         }
4596         // NSEC or SOA records that are not added to the CacheGroup do not share the name
4597         // of the CacheGroup.
4598         if (rr->resrec.name)
4599         {
4600             debugf("ReleaseAdditionalCacheRecords: freeing cached record %##s (%s)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
4601             mDNSPlatformMemFree((void *)rr->resrec.name);
4602             rr->resrec.name = mDNSNULL;
4603         }
4604         // Don't count the NSEC3 records used by anonymous browse/reg
4605         if (!rr->resrec.InterfaceID)
4606         {
4607             m->rrcache_totalused_unicast -= rr->resrec.rdlength;
4608             if (DNSSECRecordType(rr->resrec.rrtype))
4609                 BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
4610         }
4611         ReleaseCacheEntity(m, (CacheEntity *)rr);
4612     }
4613 }
4614 
4615 mDNSexport void ReleaseCacheRecord(mDNS *const m, CacheRecord *r)
4616 {
4617     CacheGroup *cg;
4618 
4619     //LogMsg("ReleaseCacheRecord: Releasing %s", CRDisplayString(m, r));
4620     if (r->resrec.rdata && r->resrec.rdata != (RData*)&r->smallrdatastorage) mDNSPlatformMemFree(r->resrec.rdata);
4621     r->resrec.rdata = mDNSNULL;
4622 
4623     cg = CacheGroupForRecord(m, &r->resrec);
4624 
4625     if (!cg)
4626     {
4627         // It is okay to have this printed for NSEC/NSEC3s
4628         LogInfo("ReleaseCacheRecord: ERROR!! cg NULL for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4629     }
4630     // When NSEC records are not added to the cache, it is usually cached at the "nsec" list
4631     // of the CacheRecord. But sometimes they may be freed without adding to the "nsec" list
4632     // (which is handled below) and in that case it should be freed here.
4633     if (r->resrec.name && cg && r->resrec.name != cg->name)
4634     {
4635         debugf("ReleaseCacheRecord: freeing %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4636         mDNSPlatformMemFree((void *)r->resrec.name);
4637     }
4638     r->resrec.name = mDNSNULL;
4639 
4640     if (r->resrec.AnonInfo)
4641     {
4642         debugf("ReleaseCacheRecord: freeing AnonInfo for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4643         FreeAnonInfo((void *)r->resrec.AnonInfo);
4644     }
4645     r->resrec.AnonInfo = mDNSNULL;
4646 
4647     if (!r->resrec.InterfaceID)
4648     {
4649         m->rrcache_totalused_unicast -= r->resrec.rdlength;
4650         if (DNSSECRecordType(r->resrec.rrtype))
4651             BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, r->resrec.rdlength);
4652     }
4653 
4654     ReleaseAdditionalCacheRecords(m, &r->nsec);
4655     ReleaseAdditionalCacheRecords(m, &r->soa);
4656 
4657     ReleaseCacheEntity(m, (CacheEntity *)r);
4658 }
4659 
4660 // Note: We want to be careful that we deliver all the CacheRecordRmv calls before delivering
4661 // CacheRecordDeferredAdd calls. The in-order nature of the cache lists ensures that all
4662 // callbacks for old records are delivered before callbacks for newer records.
4663 mDNSlocal void CheckCacheExpiration(mDNS *const m, const mDNSu32 slot, CacheGroup *const cg)
4664 {
4665     CacheRecord **rp = &cg->members;
4666 
4667     if (m->lock_rrcache) { LogMsg("CheckCacheExpiration ERROR! Cache already locked!"); return; }
4668     m->lock_rrcache = 1;
4669 
4670     while (*rp)
4671     {
4672         CacheRecord *const rr = *rp;
4673         mDNSs32 event = RRExpireTime(rr);
4674         if (m->timenow - event >= 0)    // If expired, delete it
4675         {
4676             *rp = rr->next;             // Cut it from the list
4677 
4678             verbosedebugf("CheckCacheExpiration: Deleting%7d %7d %p %s",
4679                           m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4680             if (rr->CRActiveQuestion)   // If this record has one or more active questions, tell them it's going away
4681             {
4682                 DNSQuestion *q = rr->CRActiveQuestion;
4683                 // When a cache record is about to expire, we expect to do four queries at 80-82%, 85-87%, 90-92% and
4684                 // then 95-97% of the TTL. If the DNS server does not respond, then we will remove the cache entry
4685                 // before we pick a new DNS server. As the question interval is set to MaxQuestionInterval, we may
4686                 // not send out a query anytime soon. Hence, we need to reset the question interval. If this is
4687                 // a normal deferred ADD case, then AnswerCurrentQuestionWithResourceRecord will reset it to
4688                 // MaxQuestionInterval. If we have inactive questions referring to negative cache entries,
4689                 // don't ressurect them as they will deliver duplicate "No such Record" ADD events
4690                 if (!mDNSOpaque16IsZero(q->TargetQID) && !q->LongLived && ActiveQuestion(q))
4691                 {
4692                     q->ThisQInterval = InitialQuestionInterval;
4693                     q->LastQTime     = m->timenow - q->ThisQInterval;
4694                     SetNextQueryTime(m, q);
4695                 }
4696                 CacheRecordRmv(m, rr);
4697                 m->rrcache_active--;
4698             }
4699             ReleaseCacheRecord(m, rr);
4700         }
4701         else                            // else, not expired; see if we need to query
4702         {
4703             // If waiting to delay delivery, do nothing until then
4704             if (rr->DelayDelivery && rr->DelayDelivery - m->timenow > 0)
4705                 event = rr->DelayDelivery;
4706             else
4707             {
4708                 if (rr->DelayDelivery) CacheRecordDeferredAdd(m, rr);
4709                 if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
4710                 {
4711                     if (m->timenow - rr->NextRequiredQuery < 0)     // If not yet time for next query
4712                         event = NextCacheCheckEvent(rr);            // then just record when we want the next query
4713                     else                                            // else trigger our question to go out now
4714                     {
4715                         // Set NextScheduledQuery to timenow so that SendQueries() will run.
4716                         // SendQueries() will see that we have records close to expiration, and send FEQs for them.
4717                         m->NextScheduledQuery = m->timenow;
4718                         // After sending the query we'll increment UnansweredQueries and call SetNextCacheCheckTimeForRecord(),
4719                         // which will correctly update m->NextCacheCheck for us.
4720                         event = m->timenow + FutureTime;
4721                     }
4722                 }
4723             }
4724             verbosedebugf("CheckCacheExpiration:%6d %5d %s",
4725                           (event - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m, rr));
4726             if (m->rrcache_nextcheck[slot] - event > 0)
4727                 m->rrcache_nextcheck[slot] = event;
4728             rp = &rr->next;
4729         }
4730     }
4731     if (cg->rrcache_tail != rp) verbosedebugf("CheckCacheExpiration: Updating CacheGroup tail from %p to %p", cg->rrcache_tail, rp);
4732     cg->rrcache_tail = rp;
4733     m->lock_rrcache = 0;
4734 }
4735 
4736 // "LORecord" includes both LocalOnly and P2P record. This function assumes m->CurrentQuestion is pointing to "q".
4737 //
4738 // If "CheckOnly" is set to "true", the question won't be answered but just check to see if there is an answer and
4739 // returns true if there is an answer.
4740 //
4741 // If "CheckOnly" is set to "false", the question will be answered if there is a LocalOnly/P2P record and
4742 // returns true to indicate the same.
4743 mDNSlocal mDNSBool AnswerQuestionWithLORecord(mDNS *const m, DNSQuestion *q, mDNSBool checkOnly)
4744 {
4745     AuthRecord *lr;
4746     AuthGroup *ag;
4747 
4748     if (m->CurrentRecord)
4749         LogMsg("AnswerQuestionWithLORecord ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
4750 
4751     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
4752     if (ag)
4753     {
4754         m->CurrentRecord = ag->members;
4755         while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
4756         {
4757             AuthRecord *rr = m->CurrentRecord;
4758             m->CurrentRecord = rr->next;
4759             //
4760             // If the question is mDNSInterface_LocalOnly, all records local to the machine should be used
4761             // to answer the query. This is handled in AnswerNewLocalOnlyQuestion.
4762             //
4763             // We handle mDNSInterface_Any and scoped questions here. See LocalOnlyRecordAnswersQuestion for more
4764             // details on how we handle this case. For P2P we just handle "Interface_Any" questions. For LocalOnly
4765             // we handle both mDNSInterface_Any and scoped questions.
4766 
4767             if (rr->ARType == AuthRecordLocalOnly || (rr->ARType == AuthRecordP2P && (q->InterfaceID == mDNSInterface_Any || q->InterfaceID == mDNSInterface_BLE)))
4768                 if (LocalOnlyRecordAnswersQuestion(rr, q))
4769                 {
4770                     if (checkOnly)
4771                     {
4772                         LogInfo("AnswerQuestionWithLORecord: question %##s (%s) answered by %s", q->qname.c, DNSTypeName(q->qtype),
4773                             ARDisplayString(m, rr));
4774                         m->CurrentRecord = mDNSNULL;
4775                         return mDNStrue;
4776                     }
4777                     AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
4778                     if (m->CurrentQuestion != q)
4779                         break;     // If callback deleted q, then we're finished here
4780                 }
4781         }
4782     }
4783     m->CurrentRecord = mDNSNULL;
4784 
4785     if (m->CurrentQuestion != q)
4786     {
4787         LogInfo("AnswerQuestionWithLORecord: Question deleted while while answering LocalOnly record answers");
4788         return mDNStrue;
4789     }
4790 
4791     if (q->LOAddressAnswers)
4792     {
4793         LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) answered using local auth records LOAddressAnswers %d",
4794                 q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4795         return mDNStrue;
4796     }
4797 
4798     // Before we go check the cache and ship this query on the wire, we have to be sure that there are
4799     // no local records that could possibly answer this question. As we did not check the NewLocalRecords, we
4800     // need to just peek at them to see whether it will answer this question. If it would answer, pretend
4801     // that we answered. AnswerAllLocalQuestionsWithLocalAuthRecord will answer shortly. This happens normally
4802     // when we add new /etc/hosts entries and restart the question. It is a new question and also a new record.
4803     if (ag)
4804     {
4805         lr = ag->NewLocalOnlyRecords;
4806         while (lr)
4807         {
4808             if (UniqueLocalOnlyRecord(lr) && LocalOnlyRecordAnswersQuestion(lr, q))
4809             {
4810                 LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) will be answered using new local auth records "
4811                         " LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4812                 return mDNStrue;
4813             }
4814             lr = lr->next;
4815         }
4816     }
4817     return mDNSfalse;
4818 }
4819 
4820 // Today, we suppress questions (not send them on the wire) for several reasons e.g.,
4821 // AAAA query is suppressed because no IPv6 capability or PID is not allowed to make
4822 // DNS requests. We need to temporarily suspend the suppress status so that we can
4823 // deliver a negative response (AnswerCurrentQuestionWithResourceRecord does not answer
4824 // suppressed questions) and reset it back. In the future, if there are other
4825 // reasons for suppressing the query, this function should be updated.
4826 mDNSlocal void AnswerSuppressedQuestion(mDNS *const m, DNSQuestion *q)
4827 {
4828     mDNSBool SuppressQuery;
4829     mDNSBool DisallowPID;
4830 
4831     // If the client did not set the kDNSServiceFlagsReturnIntermediates flag, then don't generate a negative response, just
4832     // deactivate the DNSQuestion.
4833     if (!q->ReturnIntermed)
4834     {
4835         q->ThisQInterval = 0;
4836         return;
4837     }
4838 
4839     SuppressQuery = q->SuppressQuery;
4840     DisallowPID   = q->DisallowPID;
4841 
4842     // make sure that QuerySuppressed() returns false
4843     q->SuppressQuery = mDNSfalse;
4844     q->DisallowPID   = mDNSfalse;
4845 
4846     GenerateNegativeResponse(m, mDNSInterface_Any, QC_suppressed);
4847 
4848     q->SuppressQuery = SuppressQuery;
4849     q->DisallowPID   = DisallowPID;
4850 }
4851 
4852 mDNSlocal void AnswerNewQuestion(mDNS *const m)
4853 {
4854     mDNSBool ShouldQueryImmediately = mDNStrue;
4855     DNSQuestion *const q = m->NewQuestions;     // Grab the question we're going to answer
4856 #if USE_DNS64
4857     if (!mDNSOpaque16IsZero(q->TargetQID)) DNS64HandleNewQuestion(m, q);
4858 #endif
4859     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
4860     mDNSBool AnsweredFromCache = mDNSfalse;
4861 
4862     verbosedebugf("AnswerNewQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4863 
4864     if (cg) CheckCacheExpiration(m, HashSlotFromNameHash(q->qnamehash), cg);
4865     if (m->NewQuestions != q) { LogInfo("AnswerNewQuestion: Question deleted while doing CheckCacheExpiration"); goto exit; }
4866     m->NewQuestions = q->next;
4867     // Advance NewQuestions to the next *after* calling CheckCacheExpiration, because if we advance it first
4868     // then CheckCacheExpiration may give this question add/remove callbacks, and it's not yet ready for that.
4869     //
4870     // Also, CheckCacheExpiration() calls CacheRecordDeferredAdd() and CacheRecordRmv(), which invoke
4871     // client callbacks, which may delete their own or any other question. Our mechanism for detecting
4872     // whether our current m->NewQuestions question got deleted by one of these callbacks is to store the
4873     // value of m->NewQuestions in 'q' before calling CheckCacheExpiration(), and then verify afterwards
4874     // that they're still the same. If m->NewQuestions has changed (because mDNS_StopQuery_internal
4875     // advanced it), that means the question was deleted, so we no longer need to worry about answering
4876     // it (and indeed 'q' is now a dangling pointer, so dereferencing it at all would be bad, and the
4877     // values we computed for slot and cg are now stale and relate to a question that no longer exists).
4878     //
4879     // We can't use the usual m->CurrentQuestion mechanism for this because  CacheRecordDeferredAdd() and
4880     // CacheRecordRmv() both use that themselves when walking the list of (non-new) questions generating callbacks.
4881     // Fortunately mDNS_StopQuery_internal auto-advances both m->CurrentQuestion *AND* m->NewQuestions when
4882     // deleting a question, so luckily we have an easy alternative way of detecting if our question got deleted.
4883 
4884     if (m->lock_rrcache) LogMsg("AnswerNewQuestion ERROR! Cache already locked!");
4885     // This should be safe, because calling the client's question callback may cause the
4886     // question list to be modified, but should not ever cause the rrcache list to be modified.
4887     // If the client's question callback deletes the question, then m->CurrentQuestion will
4888     // be advanced, and we'll exit out of the loop
4889     m->lock_rrcache = 1;
4890     if (m->CurrentQuestion)
4891         LogMsg("AnswerNewQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
4892                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4893     m->CurrentQuestion = q;     // Indicate which question we're answering, so we'll know if it gets deleted
4894 
4895     if (q->NoAnswer == NoAnswer_Fail)
4896     {
4897         LogMsg("AnswerNewQuestion: NoAnswer_Fail %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4898         MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, 60, mDNSInterface_Any, q->qDNSServer);
4899         q->NoAnswer = NoAnswer_Normal;      // Temporarily turn off answer suppression
4900         AnswerCurrentQuestionWithResourceRecord(m, &m->rec.r, QC_addnocache);
4901         // Don't touch the question if it has been stopped already
4902         if (m->CurrentQuestion == q) q->NoAnswer = NoAnswer_Fail;       // Restore NoAnswer state
4903         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
4904     }
4905 
4906     if (m->CurrentQuestion != q)
4907     {
4908         LogInfo("AnswerNewQuestion: Question deleted while generating NoAnswer_Fail response");
4909         goto exit;
4910     }
4911 
4912     // See if we want to tell it about LocalOnly/P2P records. If we answered them using LocalOnly
4913     // or P2P record, then we are done.
4914     if (AnswerQuestionWithLORecord(m, q, mDNSfalse))
4915         goto exit;
4916 
4917     // If we are not supposed to answer this question, generate a negative response.
4918     // Temporarily suspend the SuppressQuery so that AnswerCurrentQuestionWithResourceRecord can answer the question
4919     //
4920     // If it is a question trying to validate some response, it already checked the cache for a response. If it still
4921     // reissues a question it means it could not find the RRSIGs. So, we need to bypass the cache check and send
4922     // the question out.
4923     if (QuerySuppressed(q))
4924     {
4925         AnswerSuppressedQuestion(m, q);
4926     }
4927     else if (!q->ValidatingResponse)
4928     {
4929         CacheRecord *rr;
4930         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4931             if (SameNameRecordAnswersQuestion(&rr->resrec, q))
4932             {
4933                 // SecsSinceRcvd is whole number of elapsed seconds, rounded down
4934                 mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - rr->TimeRcvd)) / mDNSPlatformOneSecond;
4935                 if (rr->resrec.rroriginalttl <= SecsSinceRcvd)
4936                 {
4937                     LogMsg("AnswerNewQuestion: How is rr->resrec.rroriginalttl %lu <= SecsSinceRcvd %lu for %s %d %d",
4938                            rr->resrec.rroriginalttl, SecsSinceRcvd, CRDisplayString(m, rr), m->timenow, rr->TimeRcvd);
4939                     continue;   // Go to next one in loop
4940                 }
4941 
4942                 // If this record set is marked unique, then that means we can reasonably assume we have the whole set
4943                 // -- we don't need to rush out on the network and query immediately to see if there are more answers out there
4944                 if ((rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) || (q->ExpectUnique))
4945                     ShouldQueryImmediately = mDNSfalse;
4946                 q->CurrentAnswers++;
4947                 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4948                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4949                 AnsweredFromCache = mDNStrue;
4950                 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4951                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
4952             }
4953             else if (mDNSOpaque16IsZero(q->TargetQID) && RRTypeIsAddressType(rr->resrec.rrtype) && RRTypeIsAddressType(q->qtype))
4954                 ShouldQueryImmediately = mDNSfalse;
4955     }
4956     // We don't use LogInfo for this "Question deleted" message because it happens so routinely that
4957     // it's not remotely remarkable, and therefore unlikely to be of much help tracking down bugs.
4958     if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving cache answers"); goto exit; }
4959 
4960     // Neither a local record nor a cache entry could answer this question. If this question need to be retried
4961     // with search domains, generate a negative response which will now retry after appending search domains.
4962     // If the query was suppressed above, we already generated a negative response. When it gets unsuppressed,
4963     // we will retry with search domains.
4964     if (!QuerySuppressed(q) && !AnsweredFromCache && q->RetryWithSearchDomains)
4965     {
4966         LogInfo("AnswerNewQuestion: Generating response for retrying with search domains %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4967         GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
4968     }
4969 
4970     if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving negative answer"); goto exit; }
4971 
4972     // Note: When a query gets suppressed or retried with search domains, we de-activate the question.
4973     // Hence we don't execute the following block of code for those cases.
4974     if (ShouldQueryImmediately && ActiveQuestion(q))
4975     {
4976         debugf("AnswerNewQuestion: ShouldQueryImmediately %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4977         q->ThisQInterval  = InitialQuestionInterval;
4978         q->LastQTime      = m->timenow - q->ThisQInterval;
4979         if (mDNSOpaque16IsZero(q->TargetQID))       // For mDNS, spread packets to avoid a burst of simultaneous queries
4980         {
4981             // Compute random delay in the range 1-6 seconds, then divide by 50 to get 20-120ms
4982             if (!m->RandomQueryDelay)
4983                 m->RandomQueryDelay = (mDNSPlatformOneSecond + mDNSRandom(mDNSPlatformOneSecond*5) - 1) / 50 + 1;
4984             q->LastQTime += m->RandomQueryDelay;
4985         }
4986     }
4987 
4988     // IN ALL CASES make sure that m->NextScheduledQuery is set appropriately.
4989     // In cases where m->NewQuestions->DelayAnswering is set, we may have delayed generating our
4990     // answers for this question until *after* its scheduled transmission time, in which case
4991     // m->NextScheduledQuery may now be set to 'never', and in that case -- even though we're *not* doing
4992     // ShouldQueryImmediately -- we still need to make sure we set m->NextScheduledQuery correctly.
4993     SetNextQueryTime(m,q);
4994 
4995 exit:
4996     m->CurrentQuestion = mDNSNULL;
4997     m->lock_rrcache = 0;
4998 }
4999 
5000 // When a NewLocalOnlyQuestion is created, AnswerNewLocalOnlyQuestion runs though our ResourceRecords delivering any
5001 // appropriate answers, stopping if it reaches a NewLocalOnlyRecord -- these will be handled by AnswerAllLocalQuestionsWithLocalAuthRecord
5002 mDNSlocal void AnswerNewLocalOnlyQuestion(mDNS *const m)
5003 {
5004     AuthGroup *ag;
5005     DNSQuestion *q = m->NewLocalOnlyQuestions;      // Grab the question we're going to answer
5006     mDNSBool retEv = mDNSfalse;
5007     m->NewLocalOnlyQuestions = q->next;             // Advance NewLocalOnlyQuestions to the next (if any)
5008 
5009     debugf("AnswerNewLocalOnlyQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5010 
5011     if (m->CurrentQuestion)
5012         LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
5013                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5014     m->CurrentQuestion = q;     // Indicate which question we're answering, so we'll know if it gets deleted
5015 
5016     if (m->CurrentRecord)
5017         LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
5018 
5019     // 1. First walk the LocalOnly records answering the LocalOnly question
5020     // 2. As LocalOnly questions should also be answered by any other Auth records local to the machine,
5021     //    walk the ResourceRecords list delivering the answers
5022     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5023     if (ag)
5024     {
5025         m->CurrentRecord = ag->members;
5026         while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
5027         {
5028             AuthRecord *rr = m->CurrentRecord;
5029             m->CurrentRecord = rr->next;
5030             if (LocalOnlyRecordAnswersQuestion(rr, q))
5031             {
5032                 retEv = mDNStrue;
5033                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5034                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
5035             }
5036         }
5037     }
5038 
5039     if (m->CurrentQuestion == q)
5040     {
5041         m->CurrentRecord = m->ResourceRecords;
5042 
5043         while (m->CurrentRecord && m->CurrentRecord != m->NewLocalRecords)
5044         {
5045             AuthRecord *rr = m->CurrentRecord;
5046             m->CurrentRecord = rr->next;
5047             if (ResourceRecordAnswersQuestion(&rr->resrec, q))
5048             {
5049                 retEv = mDNStrue;
5050                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5051                 if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
5052             }
5053         }
5054     }
5055 
5056     // The local host is the authoritative source for LocalOnly questions
5057     // so if no records exist and client requested intermediates, then generate a negative response
5058     if (!retEv && (m->CurrentQuestion == q) && q->ReturnIntermed)
5059         GenerateNegativeResponse(m, mDNSInterface_LocalOnly, QC_forceresponse);
5060 
5061     m->CurrentQuestion = mDNSNULL;
5062     m->CurrentRecord   = mDNSNULL;
5063 }
5064 
5065 mDNSlocal CacheEntity *GetCacheEntity(mDNS *const m, const CacheGroup *const PreserveCG)
5066 {
5067     CacheEntity *e = mDNSNULL;
5068 
5069     if (m->lock_rrcache) { LogMsg("GetFreeCacheRR ERROR! Cache already locked!"); return(mDNSNULL); }
5070     m->lock_rrcache = 1;
5071 
5072     // If we have no free records, ask the client layer to give us some more memory
5073     if (!m->rrcache_free && m->MainCallback)
5074     {
5075         if (m->rrcache_totalused != m->rrcache_size)
5076             LogMsg("GetFreeCacheRR: count mismatch: m->rrcache_totalused %lu != m->rrcache_size %lu",
5077                    m->rrcache_totalused, m->rrcache_size);
5078 
5079         // We don't want to be vulnerable to a malicious attacker flooding us with an infinite
5080         // number of bogus records so that we keep growing our cache until the machine runs out of memory.
5081         // To guard against this, if our cache grows above 512kB (approx 3168 records at 164 bytes each),
5082         // and we're actively using less than 1/32 of that cache, then we purge all the unused records
5083         // and recycle them, instead of allocating more memory.
5084         if (m->rrcache_size > 5000 && m->rrcache_size / 32 > m->rrcache_active)
5085             LogInfo("Possible denial-of-service attack in progress: m->rrcache_size %lu; m->rrcache_active %lu",
5086                     m->rrcache_size, m->rrcache_active);
5087         else
5088         {
5089             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
5090             m->MainCallback(m, mStatus_GrowCache);
5091             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
5092         }
5093     }
5094 
5095     // If we still have no free records, recycle all the records we can.
5096     // Enumerating the entire cache is moderately expensive, so when we do it, we reclaim all the records we can in one pass.
5097     if (!m->rrcache_free)
5098     {
5099         mDNSu32 oldtotalused = m->rrcache_totalused;
5100         mDNSu32 slot;
5101         for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5102         {
5103             CacheGroup **cp = &m->rrcache_hash[slot];
5104             while (*cp)
5105             {
5106                 CacheRecord **rp = &(*cp)->members;
5107                 while (*rp)
5108                 {
5109                     // Records that answer still-active questions are not candidates for recycling
5110                     // Records that are currently linked into the CacheFlushRecords list may not be recycled, or we'll crash
5111                     if ((*rp)->CRActiveQuestion || (*rp)->NextInCFList)
5112                         rp=&(*rp)->next;
5113                     else
5114                     {
5115                         CacheRecord *rr = *rp;
5116                         *rp = (*rp)->next;          // Cut record from list
5117                         ReleaseCacheRecord(m, rr);
5118                     }
5119                 }
5120                 if ((*cp)->rrcache_tail != rp)
5121                     verbosedebugf("GetFreeCacheRR: Updating rrcache_tail[%lu] from %p to %p", slot, (*cp)->rrcache_tail, rp);
5122                 (*cp)->rrcache_tail = rp;
5123                 if ((*cp)->members || (*cp)==PreserveCG) cp=&(*cp)->next;
5124                 else ReleaseCacheGroup(m, cp);
5125             }
5126         }
5127         LogInfo("GetCacheEntity recycled %d records to reduce cache from %d to %d",
5128                 oldtotalused - m->rrcache_totalused, oldtotalused, m->rrcache_totalused);
5129     }
5130 
5131     if (m->rrcache_free)    // If there are records in the free list, take one
5132     {
5133         e = m->rrcache_free;
5134         m->rrcache_free = e->next;
5135         if (++m->rrcache_totalused >= m->rrcache_report)
5136         {
5137             LogInfo("RR Cache now using %ld objects", m->rrcache_totalused);
5138             if      (m->rrcache_report <  100) m->rrcache_report += 10;
5139             else if (m->rrcache_report < 1000) m->rrcache_report += 100;
5140             else m->rrcache_report += 1000;
5141         }
5142         mDNSPlatformMemZero(e, sizeof(*e));
5143     }
5144 
5145     m->lock_rrcache = 0;
5146 
5147     return(e);
5148 }
5149 
5150 mDNSlocal CacheRecord *GetCacheRecord(mDNS *const m, CacheGroup *cg, mDNSu16 RDLength)
5151 {
5152     CacheRecord *r = (CacheRecord *)GetCacheEntity(m, cg);
5153     if (r)
5154     {
5155         r->resrec.rdata = (RData*)&r->smallrdatastorage;    // By default, assume we're usually going to be using local storage
5156         if (RDLength > InlineCacheRDSize)           // If RDLength is too big, allocate extra storage
5157         {
5158             r->resrec.rdata = (RData*)mDNSPlatformMemAllocate(sizeofRDataHeader + RDLength);
5159             if (r->resrec.rdata) r->resrec.rdata->MaxRDLength = r->resrec.rdlength = RDLength;
5160             else { ReleaseCacheEntity(m, (CacheEntity*)r); r = mDNSNULL; }
5161         }
5162     }
5163     return(r);
5164 }
5165 
5166 mDNSlocal CacheGroup *GetCacheGroup(mDNS *const m, const mDNSu32 slot, const ResourceRecord *const rr)
5167 {
5168     mDNSu16 namelen = DomainNameLength(rr->name);
5169     CacheGroup *cg = (CacheGroup*)GetCacheEntity(m, mDNSNULL);
5170     if (!cg) { LogMsg("GetCacheGroup: Failed to allocate memory for %##s", rr->name->c); return(mDNSNULL); }
5171     cg->next         = m->rrcache_hash[slot];
5172     cg->namehash     = rr->namehash;
5173     cg->members      = mDNSNULL;
5174     cg->rrcache_tail = &cg->members;
5175     if (namelen > sizeof(cg->namestorage))
5176         cg->name = mDNSPlatformMemAllocate(namelen);
5177     else
5178         cg->name = (domainname*)cg->namestorage;
5179     if (!cg->name)
5180     {
5181         LogMsg("GetCacheGroup: Failed to allocate name storage for %##s", rr->name->c);
5182         ReleaseCacheEntity(m, (CacheEntity*)cg);
5183         return(mDNSNULL);
5184     }
5185     AssignDomainName(cg->name, rr->name);
5186 
5187     if (CacheGroupForRecord(m, rr)) LogMsg("GetCacheGroup: Already have CacheGroup for %##s", rr->name->c);
5188     m->rrcache_hash[slot] = cg;
5189     if (CacheGroupForRecord(m, rr) != cg) LogMsg("GetCacheGroup: Not finding CacheGroup for %##s", rr->name->c);
5190 
5191     return(cg);
5192 }
5193 
5194 mDNSexport void mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr)
5195 {
5196     mDNS_CheckLock(m);
5197 
5198     // Make sure we mark this record as thoroughly expired -- we don't ever want to give
5199     // a positive answer using an expired record (e.g. from an interface that has gone away).
5200     // We don't want to clear CRActiveQuestion here, because that would leave the record subject to
5201     // summary deletion without giving the proper callback to any questions that are monitoring it.
5202     // By setting UnansweredQueries to MaxUnansweredQueries we ensure it won't trigger any further expiration queries.
5203     rr->TimeRcvd          = m->timenow - mDNSPlatformOneSecond * 60;
5204     rr->UnansweredQueries = MaxUnansweredQueries;
5205     rr->resrec.rroriginalttl     = 0;
5206     SetNextCacheCheckTimeForRecord(m, rr);
5207 }
5208 
5209 mDNSexport mDNSs32 mDNS_TimeNow(const mDNS *const m)
5210 {
5211     mDNSs32 time;
5212     mDNSPlatformLock(m);
5213     if (m->mDNS_busy)
5214     {
5215         LogMsg("mDNS_TimeNow called while holding mDNS lock. This is incorrect. Code protected by lock should just use m->timenow.");
5216         if (!m->timenow) LogMsg("mDNS_TimeNow: m->mDNS_busy is %ld but m->timenow not set", m->mDNS_busy);
5217     }
5218 
5219     if (m->timenow) time = m->timenow;
5220     else time = mDNS_TimeNow_NoLock(m);
5221     mDNSPlatformUnlock(m);
5222     return(time);
5223 }
5224 
5225 // To avoid pointless CPU thrash, we use SetSPSProxyListChanged(X) to record the last interface that
5226 // had its Sleep Proxy client list change, and defer to actual BPF reconfiguration to mDNS_Execute().
5227 // (GetNextScheduledEvent() returns "now" when m->SPSProxyListChanged is set)
5228 #define SetSPSProxyListChanged(X) do { \
5229         if (m->SPSProxyListChanged && m->SPSProxyListChanged != (X)) mDNSPlatformUpdateProxyList(m->SPSProxyListChanged); \
5230         m->SPSProxyListChanged = (X); } while(0)
5231 
5232 // Called from mDNS_Execute() to expire stale proxy records
5233 mDNSlocal void CheckProxyRecords(mDNS *const m, AuthRecord *list)
5234 {
5235     m->CurrentRecord = list;
5236     while (m->CurrentRecord)
5237     {
5238         AuthRecord *rr = m->CurrentRecord;
5239         if (rr->resrec.RecordType != kDNSRecordTypeDeregistering && rr->WakeUp.HMAC.l[0])
5240         {
5241             // If m->SPSSocket is NULL that means we're not acting as a sleep proxy any more,
5242             // so we need to cease proxying for *all* records we may have, expired or not.
5243             if (m->SPSSocket && m->timenow - rr->TimeExpire < 0)    // If proxy record not expired yet, update m->NextScheduledSPS
5244             {
5245                 if (m->NextScheduledSPS - rr->TimeExpire > 0)
5246                     m->NextScheduledSPS = rr->TimeExpire;
5247             }
5248             else                                                    // else proxy record expired, so remove it
5249             {
5250                 LogSPS("CheckProxyRecords: Removing %d H-MAC %.6a I-MAC %.6a %d %s",
5251                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, ARDisplayString(m, rr));
5252                 SetSPSProxyListChanged(rr->resrec.InterfaceID);
5253                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
5254                 // Don't touch rr after this -- memory may have been free'd
5255             }
5256         }
5257         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
5258         // new records could have been added to the end of the list as a result of that call.
5259         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
5260             m->CurrentRecord = rr->next;
5261     }
5262 }
5263 
5264 mDNSlocal void CheckRmvEventsForLocalRecords(mDNS *const m)
5265 {
5266     while (m->CurrentRecord)
5267     {
5268         AuthRecord *rr = m->CurrentRecord;
5269         if (rr->AnsweredLocalQ && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
5270         {
5271             debugf("CheckRmvEventsForLocalRecords: Generating local RMV events for %s", ARDisplayString(m, rr));
5272             rr->resrec.RecordType = kDNSRecordTypeShared;
5273             AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse);
5274             if (m->CurrentRecord == rr) // If rr still exists in list, restore its state now
5275             {
5276                 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
5277                 rr->AnsweredLocalQ = mDNSfalse;
5278                 // SendResponses normally calls CompleteDeregistration after sending goodbyes.
5279                 // For LocalOnly records, we don't do that and hence we need to do that here.
5280                 if (RRLocalOnly(rr)) CompleteDeregistration(m, rr);
5281             }
5282         }
5283         if (m->CurrentRecord == rr)     // If m->CurrentRecord was not auto-advanced, do it ourselves now
5284             m->CurrentRecord = rr->next;
5285     }
5286 }
5287 
5288 mDNSlocal void TimeoutQuestions_internal(mDNS *const m, DNSQuestion* questions, mDNSInterfaceID InterfaceID)
5289 {
5290     if (m->CurrentQuestion)
5291         LogMsg("TimeoutQuestions ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c,
5292                DNSTypeName(m->CurrentQuestion->qtype));
5293     m->CurrentQuestion = questions;
5294     while (m->CurrentQuestion)
5295     {
5296         DNSQuestion *const q = m->CurrentQuestion;
5297         if (q->StopTime)
5298         {
5299             if (!q->TimeoutQuestion)
5300                 LogMsg("TimeoutQuestions: ERROR!! TimeoutQuestion not set, but StopTime set for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5301 
5302             if (m->timenow - q->StopTime >= 0)
5303             {
5304                 LogInfo("TimeoutQuestions: question %p %##s timed out, time %d", q, q->qname.c, m->timenow - q->StopTime);
5305                 q->LOAddressAnswers = 0; // unset since timing out the question
5306                 GenerateNegativeResponse(m, InterfaceID, QC_forceresponse);
5307                 if (m->CurrentQuestion == q) q->StopTime = 0;
5308             }
5309             else
5310             {
5311                 if (m->NextScheduledStopTime - q->StopTime > 0)
5312                     m->NextScheduledStopTime = q->StopTime;
5313             }
5314         }
5315         // If m->CurrentQuestion wasn't modified out from under us, advance it now
5316         // We can't do this at the start of the loop because GenerateNegativeResponse
5317         // depends on having m->CurrentQuestion point to the right question
5318         if (m->CurrentQuestion == q)
5319             m->CurrentQuestion = q->next;
5320     }
5321     m->CurrentQuestion = mDNSNULL;
5322 }
5323 
5324 mDNSlocal void TimeoutQuestions(mDNS *const m)
5325 {
5326     m->NextScheduledStopTime = m->timenow + FutureTime; // push reschedule of TimeoutQuestions to way off into the future
5327     TimeoutQuestions_internal(m, m->Questions, mDNSInterface_Any);
5328     TimeoutQuestions_internal(m, m->LocalOnlyQuestions, mDNSInterface_LocalOnly);
5329 }
5330 
5331 mDNSlocal void mDNSCoreFreeProxyRR(mDNS *const m)
5332 {
5333     AuthRecord *rrPtr = m->SPSRRSet, *rrNext = mDNSNULL;
5334     LogSPS("%s : Freeing stored sleep proxy A/AAAA records", __func__);
5335     while (rrPtr)
5336     {
5337         rrNext = rrPtr->next;
5338         mDNSPlatformMemFree(rrPtr);
5339         rrPtr  = rrNext;
5340     }
5341     m->SPSRRSet = mDNSNULL;
5342 }
5343 
5344 mDNSexport mDNSs32 mDNS_Execute(mDNS *const m)
5345 {
5346     mDNS_Lock(m);   // Must grab lock before trying to read m->timenow
5347 
5348     if (m->timenow - m->NextScheduledEvent >= 0)
5349     {
5350         int i;
5351         AuthRecord *head, *tail;
5352         mDNSu32 slot;
5353         AuthGroup *ag;
5354 
5355         verbosedebugf("mDNS_Execute");
5356 
5357         if (m->CurrentQuestion)
5358             LogMsg("mDNS_Execute: ERROR m->CurrentQuestion already set: %##s (%s)",
5359                    m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5360 
5361         if (m->CurrentRecord)
5362             LogMsg("mDNS_Execute: ERROR m->CurrentRecord already set: %s", ARDisplayString(m, m->CurrentRecord));
5363 
5364         // 1. If we're past the probe suppression time, we can clear it
5365         if (m->SuppressProbes && m->timenow - m->SuppressProbes >= 0) m->SuppressProbes = 0;
5366 
5367         // 2. If it's been more than ten seconds since the last probe failure, we can clear the counter
5368         if (m->NumFailedProbes && m->timenow - m->ProbeFailTime >= mDNSPlatformOneSecond * 10) m->NumFailedProbes = 0;
5369 
5370         // 3. Purge our cache of stale old records
5371         if (m->rrcache_size && m->timenow - m->NextCacheCheck >= 0)
5372         {
5373             mDNSu32 numchecked = 0;
5374             m->NextCacheCheck = m->timenow + FutureTime;
5375             for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5376             {
5377                 if (m->timenow - m->rrcache_nextcheck[slot] >= 0)
5378                 {
5379                     CacheGroup **cp = &m->rrcache_hash[slot];
5380                     m->rrcache_nextcheck[slot] = m->timenow + FutureTime;
5381                     while (*cp)
5382                     {
5383                         debugf("m->NextCacheCheck %4d Slot %3d %##s", numchecked, slot, *cp ? (*cp)->name : (domainname*)"\x04NULL");
5384                         numchecked++;
5385                         CheckCacheExpiration(m, slot, *cp);
5386                         if ((*cp)->members) cp=&(*cp)->next;
5387                         else ReleaseCacheGroup(m, cp);
5388                     }
5389                 }
5390                 // Even if we didn't need to actually check this slot yet, still need to
5391                 // factor its nextcheck time into our overall NextCacheCheck value
5392                 if (m->NextCacheCheck - m->rrcache_nextcheck[slot] > 0)
5393                     m->NextCacheCheck = m->rrcache_nextcheck[slot];
5394             }
5395             debugf("m->NextCacheCheck %4d checked, next in %d", numchecked, m->NextCacheCheck - m->timenow);
5396         }
5397 
5398         if (m->timenow - m->NextScheduledSPS >= 0)
5399         {
5400             m->NextScheduledSPS = m->timenow + FutureTime;
5401             CheckProxyRecords(m, m->DuplicateRecords);  // Clear m->DuplicateRecords first, then m->ResourceRecords
5402             CheckProxyRecords(m, m->ResourceRecords);
5403         }
5404 
5405         SetSPSProxyListChanged(mDNSNULL);       // Perform any deferred BPF reconfiguration now
5406 
5407         // Check to see if we need to send any keepalives. Do this after we called CheckProxyRecords above
5408         // as records could have expired during that check
5409         if (m->timenow - m->NextScheduledKA >= 0)
5410         {
5411             m->NextScheduledKA = m->timenow + FutureTime;
5412             mDNS_SendKeepalives(m);
5413         }
5414 
5415 #if BONJOUR_ON_DEMAND
5416         if (m->NextBonjourDisableTime && (m->timenow - m->NextBonjourDisableTime >= 0))
5417         {
5418             // Schedule immediate network change processing to leave the multicast group
5419             // since the delay time has expired since the previous active registration or query.
5420             m->NetworkChanged = m->timenow;
5421             m->NextBonjourDisableTime = 0;
5422             m->BonjourEnabled = 0;
5423 
5424             LogInfo("mDNS_Execute: Scheduled network changed processing to leave multicast group.");
5425         }
5426 #endif // BONJOUR_ON_DEMAND
5427 
5428         // Clear AnnounceOwner if necessary. (Do this *before* SendQueries() and SendResponses().)
5429         if (m->AnnounceOwner && m->timenow - m->AnnounceOwner >= 0)
5430         {
5431             m->AnnounceOwner = 0;
5432 
5433             // This is a good time to reset the delay counter used to prevent spurious conflicts
5434             m->DelayConflictProcessing = 0;
5435         }
5436 
5437         if (m->DelaySleep && m->timenow - m->DelaySleep >= 0)
5438         {
5439             m->DelaySleep = 0;
5440             if (m->SleepState == SleepState_Transferring)
5441             {
5442                 LogSPS("Re-sleep delay passed; now checking for Sleep Proxy Servers");
5443                 BeginSleepProcessing(m);
5444             }
5445         }
5446 
5447         // 4. See if we can answer any of our new local questions from the cache
5448         for (i=0; m->NewQuestions && i<1000; i++)
5449         {
5450             if (m->NewQuestions->DelayAnswering && m->timenow - m->NewQuestions->DelayAnswering < 0) break;
5451             AnswerNewQuestion(m);
5452         }
5453         if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewQuestion exceeded loop limit");
5454 
5455         // Make sure we deliver *all* local RMV events, and clear the corresponding rr->AnsweredLocalQ flags, *before*
5456         // we begin generating *any* new ADD events in the m->NewLocalOnlyQuestions and m->NewLocalRecords loops below.
5457         for (i=0; i<1000 && m->LocalRemoveEvents; i++)
5458         {
5459             m->LocalRemoveEvents = mDNSfalse;
5460             m->CurrentRecord = m->ResourceRecords;
5461             CheckRmvEventsForLocalRecords(m);
5462             // Walk the LocalOnly records and deliver the RMV events
5463             for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5464                 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5465                 {
5466                     m->CurrentRecord = ag->members;
5467                     if (m->CurrentRecord) CheckRmvEventsForLocalRecords(m);
5468                 }
5469         }
5470 
5471         if (i >= 1000) LogMsg("mDNS_Execute: m->LocalRemoveEvents exceeded loop limit");
5472 
5473         for (i=0; m->NewLocalOnlyQuestions && i<1000; i++) AnswerNewLocalOnlyQuestion(m);
5474         if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewLocalOnlyQuestion exceeded loop limit");
5475 
5476         head = tail = mDNSNULL;
5477         for (i=0; i<1000 && m->NewLocalRecords && m->NewLocalRecords != head; i++)
5478         {
5479             AuthRecord *rr = m->NewLocalRecords;
5480             m->NewLocalRecords = m->NewLocalRecords->next;
5481             if (LocalRecordReady(rr))
5482             {
5483                 debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5484                 AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNStrue);
5485             }
5486             else if (!rr->next)
5487             {
5488                 // If we have just one record that is not ready, we don't have to unlink and
5489                 // reinsert. As the NewLocalRecords will be NULL for this case, the loop will
5490                 // terminate and set the NewLocalRecords to rr.
5491                 debugf("mDNS_Execute: Just one LocalAuthRecord %s, breaking out of the loop early", ARDisplayString(m, rr));
5492                 if (head != mDNSNULL || m->NewLocalRecords != mDNSNULL)
5493                     LogMsg("mDNS_Execute: ERROR!!: head %p, NewLocalRecords %p", head, m->NewLocalRecords);
5494 
5495                 head = rr;
5496             }
5497             else
5498             {
5499                 AuthRecord **p = &m->ResourceRecords;   // Find this record in our list of active records
5500                 debugf("mDNS_Execute: Skipping LocalAuthRecord %s", ARDisplayString(m, rr));
5501                 // if this is the first record we are skipping, move to the end of the list.
5502                 // if we have already skipped records before, append it at the end.
5503                 while (*p && *p != rr) p=&(*p)->next;
5504                 if (*p) *p = rr->next;                  // Cut this record from the list
5505                 else { LogMsg("mDNS_Execute: ERROR!! Cannot find record %s in ResourceRecords list", ARDisplayString(m, rr)); break; }
5506                 if (!head)
5507                 {
5508                     while (*p) p=&(*p)->next;
5509                     *p = rr;
5510                     head = tail = rr;
5511                 }
5512                 else
5513                 {
5514                     tail->next = rr;
5515                     tail = rr;
5516                 }
5517                 rr->next = mDNSNULL;
5518             }
5519         }
5520         m->NewLocalRecords = head;
5521         debugf("mDNS_Execute: Setting NewLocalRecords to %s", (head ? ARDisplayString(m, head) : "NULL"));
5522 
5523         if (i >= 1000) LogMsg("mDNS_Execute: m->NewLocalRecords exceeded loop limit");
5524 
5525         // Check to see if we have any new LocalOnly/P2P records to examine for delivering
5526         // to our local questions
5527         if (m->NewLocalOnlyRecords)
5528         {
5529             m->NewLocalOnlyRecords = mDNSfalse;
5530             for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5531                 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5532                 {
5533                     for (i=0; i<100 && ag->NewLocalOnlyRecords; i++)
5534                     {
5535                         AuthRecord *rr = ag->NewLocalOnlyRecords;
5536                         ag->NewLocalOnlyRecords = ag->NewLocalOnlyRecords->next;
5537                         // LocalOnly records should always be ready as they never probe
5538                         if (LocalRecordReady(rr))
5539                         {
5540                             debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5541                             AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNStrue);
5542                         }
5543                         else LogMsg("mDNS_Execute: LocalOnlyRecord %s not ready", ARDisplayString(m, rr));
5544                     }
5545                     // We limit about 100 per AuthGroup that can be serviced at a time
5546                     if (i >= 100) LogMsg("mDNS_Execute: ag->NewLocalOnlyRecords exceeded loop limit");
5547                 }
5548         }
5549 
5550         // 5. See what packets we need to send
5551         if (m->mDNSPlatformStatus != mStatus_NoError || (m->SleepState == SleepState_Sleeping))
5552             DiscardDeregistrations(m);
5553         if (m->mDNSPlatformStatus == mStatus_NoError && (m->SuppressSending == 0 || m->timenow - m->SuppressSending >= 0))
5554         {
5555             // If the platform code is ready, and we're not suppressing packet generation right now
5556             // then send our responses, probes, and questions.
5557             // We check the cache first, because there might be records close to expiring that trigger questions to refresh them.
5558             // We send queries next, because there might be final-stage probes that complete their probing here, causing
5559             // them to advance to announcing state, and we want those to be included in any announcements we send out.
5560             // Finally, we send responses, including the previously mentioned records that just completed probing.
5561             m->SuppressSending = 0;
5562 
5563             // 6. Send Query packets. This may cause some probing records to advance to announcing state
5564             if (m->timenow - m->NextScheduledQuery >= 0 || m->timenow - m->NextScheduledProbe >= 0) SendQueries(m);
5565             if (m->timenow - m->NextScheduledQuery >= 0)
5566             {
5567                 DNSQuestion *q;
5568                 LogMsg("mDNS_Execute: SendQueries didn't send all its queries (%d - %d = %d) will try again in one second",
5569                        m->timenow, m->NextScheduledQuery, m->timenow - m->NextScheduledQuery);
5570                 m->NextScheduledQuery = m->timenow + mDNSPlatformOneSecond;
5571                 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
5572                     if (ActiveQuestion(q) && m->timenow - NextQSendTime(q) >= 0)
5573                         LogMsg("mDNS_Execute: SendQueries didn't send %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5574             }
5575             if (m->timenow - m->NextScheduledProbe >= 0)
5576             {
5577                 LogMsg("mDNS_Execute: SendQueries didn't send all its probes (%d - %d = %d) will try again in one second",
5578                        m->timenow, m->NextScheduledProbe, m->timenow - m->NextScheduledProbe);
5579                 m->NextScheduledProbe = m->timenow + mDNSPlatformOneSecond;
5580             }
5581 
5582             // 7. Send Response packets, including probing records just advanced to announcing state
5583             if (m->timenow - m->NextScheduledResponse >= 0) SendResponses(m);
5584             if (m->timenow - m->NextScheduledResponse >= 0)
5585             {
5586                 LogMsg("mDNS_Execute: SendResponses didn't send all its responses; will try again in one second");
5587                 m->NextScheduledResponse = m->timenow + mDNSPlatformOneSecond;
5588             }
5589         }
5590 
5591         // Clear RandomDelay values, ready to pick a new different value next time
5592         m->RandomQueryDelay     = 0;
5593         m->RandomReconfirmDelay = 0;
5594 
5595         // See if any questions (or local-only questions) have timed out
5596         if (m->NextScheduledStopTime && m->timenow - m->NextScheduledStopTime >= 0) TimeoutQuestions(m);
5597 #ifndef UNICAST_DISABLED
5598         if (m->NextSRVUpdate && m->timenow - m->NextSRVUpdate >= 0) UpdateAllSRVRecords(m);
5599         if (m->timenow - m->NextScheduledNATOp >= 0) CheckNATMappings(m);
5600         if (m->timenow - m->NextuDNSEvent >= 0) uDNS_Tasks(m);
5601 #endif
5602 #if APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5603         extern void serviceBLE();
5604         if (m->NextBLEServiceTime && (m->timenow - m->NextBLEServiceTime >= 0)) serviceBLE();
5605 #endif // APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5606     }
5607 
5608     // Note about multi-threaded systems:
5609     // On a multi-threaded system, some other thread could run right after the mDNS_Unlock(),
5610     // performing mDNS API operations that change our next scheduled event time.
5611     //
5612     // On multi-threaded systems (like the current Windows implementation) that have a single main thread
5613     // calling mDNS_Execute() (and other threads allowed to call mDNS API routines) it is the responsibility
5614     // of the mDNSPlatformUnlock() routine to signal some kind of stateful condition variable that will
5615     // signal whatever blocking primitive the main thread is using, so that it will wake up and execute one
5616     // more iteration of its loop, and immediately call mDNS_Execute() again. The signal has to be stateful
5617     // in the sense that if the main thread has not yet entered its blocking primitive, then as soon as it
5618     // does, the state of the signal will be noticed, causing the blocking primitive to return immediately
5619     // without blocking. This avoids the race condition between the signal from the other thread arriving
5620     // just *before* or just *after* the main thread enters the blocking primitive.
5621     //
5622     // On multi-threaded systems (like the current Mac OS 9 implementation) that are entirely timer-driven,
5623     // with no main mDNS_Execute() thread, it is the responsibility of the mDNSPlatformUnlock() routine to
5624     // set the timer according to the m->NextScheduledEvent value, and then when the timer fires, the timer
5625     // callback function should call mDNS_Execute() (and ignore the return value, which may already be stale
5626     // by the time it gets to the timer callback function).
5627 
5628     mDNS_Unlock(m);     // Calling mDNS_Unlock is what gives m->NextScheduledEvent its new value
5629     return(m->NextScheduledEvent);
5630 }
5631 
5632 #ifndef UNICAST_DISABLED
5633 mDNSlocal void SuspendLLQs(mDNS *m)
5634 {
5635     DNSQuestion *q;
5636     for (q = m->Questions; q; q = q->next)
5637         if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->state == LLQ_Established)
5638         { q->ReqLease = 0; sendLLQRefresh(m, q); }
5639 }
5640 #endif // UNICAST_DISABLED
5641 
5642 mDNSlocal mDNSBool QuestionHasLocalAnswers(mDNS *const m, DNSQuestion *q)
5643 {
5644     AuthRecord *rr;
5645     AuthGroup *ag;
5646 
5647     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5648     if (ag)
5649     {
5650         for (rr = ag->members; rr; rr=rr->next)
5651             // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
5652             if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
5653             {
5654                 LogInfo("QuestionHasLocalAnswers: Question %p %##s (%s) has local answer %s", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr));
5655                 return mDNStrue;
5656             }
5657     }
5658     return mDNSfalse;
5659 }
5660 
5661 // ActivateUnicastQuery() is called from three places:
5662 // 1. When a new question is created
5663 // 2. On wake from sleep
5664 // 3. When the DNS configuration changes
5665 // In case 1 we don't want to mess with our established ThisQInterval and LastQTime (ScheduleImmediately is false)
5666 // In cases 2 and 3 we do want to cause the question to be resent immediately (ScheduleImmediately is true)
5667 mDNSlocal void ActivateUnicastQuery(mDNS *const m, DNSQuestion *const question, mDNSBool ScheduleImmediately)
5668 {
5669     // For now this AutoTunnel stuff is specific to Mac OS X.
5670     // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
5671 #if APPLE_OSX_mDNSResponder
5672     // Even though BTMM client tunnels are only useful for AAAA queries, we need to treat v4 and v6 queries equally.
5673     // Otherwise we can get the situation where the A query completes really fast (with an NXDOMAIN result) and the
5674     // caller then gives up waiting for the AAAA result while we're still in the process of setting up the tunnel.
5675     // To level the playing field, we block both A and AAAA queries while tunnel setup is in progress, and then
5676     // returns results for both at the same time. If we are looking for the _autotunnel6 record, then skip this logic
5677     // as this would trigger looking up _autotunnel6._autotunnel6 and end up failing the original query.
5678 
5679     if (RRTypeIsAddressType(question->qtype) && PrivateQuery(question) &&
5680         !SameDomainLabel(question->qname.c, (const mDNSu8 *)"\x0c_autotunnel6")&& question->QuestionCallback != AutoTunnelCallback)
5681     {
5682         question->NoAnswer = NoAnswer_Suspended;
5683         AddNewClientTunnel(question);
5684         return;
5685     }
5686 #endif // APPLE_OSX_mDNSResponder
5687 
5688     if (!question->DuplicateOf)
5689     {
5690         debugf("ActivateUnicastQuery: %##s %s%s%s",
5691                question->qname.c, DNSTypeName(question->qtype), PrivateQuery(question) ? " (Private)" : "", ScheduleImmediately ? " ScheduleImmediately" : "");
5692         question->CNAMEReferrals = 0;
5693         if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
5694         if (question->LongLived)
5695         {
5696             question->state = LLQ_InitialRequest;
5697             question->id = zeroOpaque64;
5698             question->servPort = zeroIPPort;
5699             if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
5700         }
5701         // If the question has local answers, then we don't want answers from outside
5702         if (ScheduleImmediately && !QuestionHasLocalAnswers(m, question))
5703         {
5704             question->ThisQInterval = InitialQuestionInterval;
5705             question->LastQTime     = m->timenow - question->ThisQInterval;
5706             SetNextQueryTime(m, question);
5707         }
5708     }
5709 }
5710 
5711 // Caller should hold the lock
5712 mDNSexport void mDNSCoreRestartAddressQueries(mDNS *const m, mDNSBool SearchDomainsChanged, FlushCache flushCacheRecords,
5713                                               CallbackBeforeStartQuery BeforeStartCallback, void *context)
5714 {
5715     DNSQuestion *q;
5716     DNSQuestion *restart = mDNSNULL;
5717 
5718     mDNS_CheckLock(m);
5719 
5720     // 1. Flush the cache records
5721     if (flushCacheRecords) flushCacheRecords(m);
5722 
5723     // 2. Even though we may have purged the cache records above, before it can generate RMV event
5724     // we are going to stop the question. Hence we need to deliver the RMV event before we
5725     // stop the question.
5726     //
5727     // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
5728     // application callback can potentially stop the current question (detected by CurrentQuestion) or
5729     // *any* other question which could be the next one that we may process here. RestartQuestion
5730     // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
5731     // if the "next" question is stopped while the CurrentQuestion is stopped
5732 
5733     if (m->RestartQuestion)
5734         LogMsg("mDNSCoreRestartAddressQueries: ERROR!! m->RestartQuestion already set: %##s (%s)",
5735                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
5736 
5737     m->RestartQuestion = m->Questions;
5738     while (m->RestartQuestion)
5739     {
5740         q = m->RestartQuestion;
5741         m->RestartQuestion = q->next;
5742         // GetZoneData questions are referenced by other questions (original query that started the GetZoneData
5743         // question)  through their "nta" pointer. Normally when the original query stops, it stops the
5744         // GetZoneData question and also frees the memory (See CancelGetZoneData). If we stop the GetZoneData
5745         // question followed by the original query that refers to this GetZoneData question, we will end up
5746         // freeing the GetZoneData question and then start the "freed" question at the end.
5747 
5748         if (IsGetZoneDataQuestion(q))
5749         {
5750             DNSQuestion *refq = q->next;
5751             LogInfo("mDNSCoreRestartAddressQueries: Skipping GetZoneDataQuestion %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5752             // debug stuff, we just try to find the referencing question and don't do much with it
5753             while (refq)
5754             {
5755                 if (q == &refq->nta->question)
5756                 {
5757                     LogInfo("mDNSCoreRestartAddressQueries: Question %p %##s (%s) referring to GetZoneDataQuestion %p, not stopping", refq, refq->qname.c, DNSTypeName(refq->qtype), q);
5758                 }
5759                 refq = refq->next;
5760             }
5761             continue;
5762         }
5763 
5764         // This function is called when /etc/hosts changes and that could affect A, AAAA and CNAME queries
5765         if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA && q->qtype != kDNSType_CNAME) continue;
5766 
5767         // If the search domains did not change, then we restart all the queries. Otherwise, only
5768         // for queries for which we "might" have appended search domains ("might" because we may
5769         // find results before we apply search domains even though AppendSearchDomains is set to 1)
5770         if (!SearchDomainsChanged || q->AppendSearchDomains)
5771         {
5772             // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
5773             // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
5774             // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers). Let us say that
5775             // /etc/hosts has an A Record for web.apple.com. Any queries for web.apple.com will be answered locally.
5776             // But this can't prevent a CNAME/AAAA query to not to be sent on the wire. When it is sent on the wire,
5777             // it could create cache entries. When we are restarting queries, we can't deliver the cache RMV events
5778             // for the original query using these cache entries as ADDs were never delivered using these cache
5779             // entries and hence this order is needed.
5780 
5781             // If the query is suppressed, the RMV events won't be delivered
5782             if (!CacheRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Cache Record RMV events"); continue; }
5783 
5784             // SuppressQuery status does not affect questions that are answered using local records
5785             if (!LocalRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Local Record RMV events"); continue; }
5786 
5787             LogInfo("mDNSCoreRestartAddressQueries: Stop question %p %##s (%s), AppendSearchDomains %d, qnameOrig %p", q,
5788                     q->qname.c, DNSTypeName(q->qtype), q->AppendSearchDomains, q->qnameOrig);
5789             mDNS_StopQuery_internal(m, q);
5790             // Reset state so that it looks like it was in the beginning i.e it should look at /etc/hosts, cache
5791             // and then search domains should be appended. At the beginning, qnameOrig was NULL.
5792             if (q->qnameOrig)
5793             {
5794                 LogInfo("mDNSCoreRestartAddressQueries: qnameOrig %##s", q->qnameOrig);
5795                 AssignDomainName(&q->qname, q->qnameOrig);
5796                 mDNSPlatformMemFree(q->qnameOrig);
5797                 q->qnameOrig = mDNSNULL;
5798                 q->RetryWithSearchDomains = ApplySearchDomainsFirst(q) ? 1 : 0;
5799             }
5800             q->SearchListIndex = 0;
5801             q->next = restart;
5802             restart = q;
5803         }
5804     }
5805 
5806     // 3. Callback before we start the query
5807     if (BeforeStartCallback) BeforeStartCallback(m, context);
5808 
5809     // 4. Restart all the stopped queries
5810     while (restart)
5811     {
5812         q = restart;
5813         restart = restart->next;
5814         q->next = mDNSNULL;
5815         LogInfo("mDNSCoreRestartAddressQueries: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5816         mDNS_StartQuery_internal(m, q);
5817     }
5818 }
5819 
5820 mDNSexport void mDNSCoreRestartQueries(mDNS *const m)
5821 {
5822     DNSQuestion *q;
5823 
5824 #ifndef UNICAST_DISABLED
5825     // Retrigger all our uDNS questions
5826     if (m->CurrentQuestion)
5827         LogMsg("mDNSCoreRestartQueries: ERROR m->CurrentQuestion already set: %##s (%s)",
5828                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5829     m->CurrentQuestion = m->Questions;
5830     while (m->CurrentQuestion)
5831     {
5832         q = m->CurrentQuestion;
5833         m->CurrentQuestion = m->CurrentQuestion->next;
5834         if (!mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q)) ActivateUnicastQuery(m, q, mDNStrue);
5835     }
5836 #endif
5837 
5838     // Retrigger all our mDNS questions
5839     for (q = m->Questions; q; q=q->next)                // Scan our list of questions
5840             mDNSCoreRestartQuestion(m, q);
5841 }
5842 
5843 // restart question if it's multicast and currently active
5844 mDNSexport void mDNSCoreRestartQuestion(mDNS *const m, DNSQuestion *q)
5845 {
5846     if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q))
5847     {
5848         q->ThisQInterval    = InitialQuestionInterval;  // MUST be > zero for an active question
5849         q->RequestUnicast   = kDefaultRequestUnicastCount;
5850         q->LastQTime        = m->timenow - q->ThisQInterval;
5851         q->RecentAnswerPkts = 0;
5852         ExpireDupSuppressInfo(q->DupSuppress, m->timenow);
5853         m->NextScheduledQuery = m->timenow;
5854     }
5855 }
5856 
5857 // restart the probe/announce cycle for multicast record
5858 mDNSexport void mDNSCoreRestartRegistration(mDNS *const m, AuthRecord *rr, int announceCount)
5859 {
5860     if (!AuthRecord_uDNS(rr))
5861     {
5862         if (rr->resrec.RecordType == kDNSRecordTypeVerified && !rr->DependentOn) rr->resrec.RecordType = kDNSRecordTypeUnique;
5863         rr->ProbeCount     = DefaultProbeCountForRecordType(rr->resrec.RecordType);
5864 
5865         if (mDNS_KeepaliveRecord(&rr->resrec))
5866         {
5867             rr->AnnounceCount = 0; // Do not announce keepalive records
5868         }
5869         else
5870         {
5871             // announceCount < 0 indicates default announce count should be used
5872             if (announceCount < 0)
5873                 announceCount = InitialAnnounceCount;
5874             if (rr->AnnounceCount < (mDNSu8)announceCount)
5875                 rr->AnnounceCount = (mDNSu8)announceCount;
5876         }
5877 
5878         rr->SendNSECNow    = mDNSNULL;
5879         InitializeLastAPTime(m, rr);
5880     }
5881 }
5882 
5883 // ***************************************************************************
5884 #if COMPILER_LIKES_PRAGMA_MARK
5885 #pragma mark -
5886 #pragma mark - Power Management (Sleep/Wake)
5887 #endif
5888 
5889 mDNSexport void mDNS_UpdateAllowSleep(mDNS *const m)
5890 {
5891 #ifndef IDLESLEEPCONTROL_DISABLED
5892     mDNSBool allowSleep = mDNStrue;
5893     char reason[128];
5894 
5895     reason[0] = 0;
5896 
5897     if (m->SystemSleepOnlyIfWakeOnLAN)
5898     {
5899         // Don't sleep if we are a proxy for any services
5900         if (m->ProxyRecords)
5901         {
5902             allowSleep = mDNSfalse;
5903             mDNS_snprintf(reason, sizeof(reason), "sleep proxy for %d records", m->ProxyRecords);
5904             LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because we are proxying %d records", m->ProxyRecords);
5905         }
5906 
5907         if (allowSleep && mDNSCoreHaveAdvertisedMulticastServices(m))
5908         {
5909             // Scan the list of active interfaces
5910             NetworkInterfaceInfo *intf;
5911             for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
5912             {
5913                 if (intf->McastTxRx && !intf->Loopback && !mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
5914                 {
5915                     // Disallow sleep if this interface doesn't support NetWake
5916                     if (!intf->NetWake)
5917                     {
5918                         allowSleep = mDNSfalse;
5919                         mDNS_snprintf(reason, sizeof(reason), "%s does not support NetWake", intf->ifname);
5920                         LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s does not support NetWake", intf->ifname);
5921                         break;
5922                     }
5923 
5924                     // If the interface can be an in-NIC Proxy, we should check if it can accomodate all the records
5925                     // that will be offloaded. If not, we should prevent sleep.
5926                     // This check will be possible once the lower layers provide an API to query the space available for offloads on the NIC.
5927 #if APPLE_OSX_mDNSResponder
5928                     if (!SupportsInNICProxy(intf))
5929 #endif
5930                     {
5931                         // Disallow sleep if there is no sleep proxy server
5932                         const CacheRecord *cr = FindSPSInCache1(m, &intf->NetWakeBrowse, mDNSNULL, mDNSNULL);
5933                         if ( cr == mDNSNULL)
5934                         {
5935                             allowSleep = mDNSfalse;
5936                             mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server on %s", intf->ifname);
5937                             LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server", intf->ifname);
5938                             break;
5939                         }
5940                         else if (m->SPSType != 0)
5941                         {
5942                             mDNSu32 mymetric = LocalSPSMetric(m);
5943                             mDNSu32 metric   = SPSMetric(cr->resrec.rdata->u.name.c);
5944                             if (metric >= mymetric)
5945                             {
5946                                 allowSleep = mDNSfalse;
5947                                 mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server with better metric on %s", intf->ifname);
5948                                 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server with a better metric", intf->ifname);
5949                                 break;
5950                             }
5951                         }
5952                     }
5953                 }
5954             }
5955         }
5956     }
5957 
5958     // Call the platform code to enable/disable sleep
5959     mDNSPlatformSetAllowSleep(allowSleep, reason);
5960 #else
5961     (void) m;
5962 #endif /* !defined(IDLESLEEPCONTROL_DISABLED) */
5963 }
5964 
5965 mDNSlocal mDNSBool mDNSUpdateOkToSend(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSu32 scopeid)
5966 {
5967     // If it is not a uDNS record, check to see if the updateid is zero. "updateid" is cleared when we have
5968     // sent the resource record on all the interfaces. If the update id is not zero, check to see if it is time
5969     // to send.
5970     if (AuthRecord_uDNS(rr) || (rr->AuthFlags & AuthFlagsWakeOnly) || mDNSOpaque16IsZero(rr->updateid) ||
5971         m->timenow - (rr->LastAPTime + rr->ThisAPInterval) < 0)
5972     {
5973         return mDNSfalse;
5974     }
5975 
5976     // If we have a pending registration for "scopeid", it is ok to send the update on that interface.
5977     // If the scopeid is too big to check for validity, we don't check against updateIntID. When
5978     // we successfully update on all the interfaces (with whatever set in "rr->updateIntID"), we clear
5979     // updateid and we should have returned from above.
5980     //
5981     // Note: scopeid is the same as intf->InterfaceID. It is passed in so that we don't have to call the
5982     // platform function to extract the value from "intf" every time.
5983 
5984     if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
5985         (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
5986         return mDNStrue;
5987 
5988     return mDNSfalse;
5989 }
5990 
5991 mDNSexport void UpdateRMAC(mDNS *const m, void *context)
5992 {
5993     IPAddressMACMapping *addrmap = (IPAddressMACMapping *)context ;
5994     m->CurrentRecord = m->ResourceRecords;
5995 
5996     if (!addrmap)
5997     {
5998         LogMsg("UpdateRMAC: Address mapping is NULL");
5999         return;
6000     }
6001 
6002     while (m->CurrentRecord)
6003     {
6004         AuthRecord *rr = m->CurrentRecord;
6005         // If this is a non-sleep proxy keepalive record and the remote IP address matches, update the RData
6006         if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
6007         {
6008             mDNSAddr raddr;
6009             getKeepaliveRaddr(m, rr, &raddr);
6010             if (mDNSSameAddress(&raddr, &addrmap->ipaddr))
6011             {
6012                 // Update the MAC address only if it is not a zero MAC address
6013                 mDNSEthAddr macAddr;
6014                 mDNSu8 *ptr = GetValueForMACAddr((mDNSu8 *)(addrmap->ethaddr), (mDNSu8 *) (addrmap->ethaddr + sizeof(addrmap->ethaddr)), &macAddr);
6015                 if (ptr != mDNSNULL && !mDNSEthAddressIsZero(macAddr))
6016                 {
6017                     UpdateKeepaliveRData(m, rr, mDNSNULL, mDNStrue, (char *)(addrmap->ethaddr));
6018                 }
6019             }
6020         }
6021         m->CurrentRecord = rr->next;
6022     }
6023 
6024     if (addrmap)
6025         mDNSPlatformMemFree(addrmap);
6026 
6027 }
6028 
6029 mDNSexport mStatus UpdateKeepaliveRData(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSBool updateMac, char *ethAddr)
6030 {
6031     mDNSu16 newrdlength;
6032     mDNSAddr laddr = zeroAddr;
6033     mDNSAddr raddr = zeroAddr;
6034     mDNSEthAddr eth = zeroEthAddr;
6035     mDNSIPPort lport = zeroIPPort;
6036     mDNSIPPort rport = zeroIPPort;
6037     mDNSu32 timeout = 0;
6038     mDNSu32 seq = 0;
6039     mDNSu32 ack = 0;
6040     mDNSu16 win = 0;
6041     UTF8str255 txt;
6042     int rdsize;
6043     RData *newrd;
6044     mDNSTCPInfo mti;
6045     mStatus ret;
6046 
6047     // Note: If we fail to update the  DNS NULL  record with additional information in this function, it will be registered
6048     // with the SPS like any other record. SPS will not send keepalives if it does not have additional information.
6049     mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
6050     if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
6051     {
6052         LogMsg("UpdateKeepaliveRData: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, &raddr, rport.NotAnInteger);
6053         return mStatus_UnknownErr;
6054     }
6055 
6056     if (updateMac)
6057     {
6058         if (laddr.type == mDNSAddrType_IPv4)
6059             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);
6060         else
6061             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);
6062 
6063     }
6064     else
6065     {
6066         // If this keepalive packet would be sent on a different interface than the current one that we are processing
6067         // now, then we don't update the DNS NULL record. But we do not prevent it from registering with the SPS. When SPS sees
6068         // this DNS NULL record, it does not send any keepalives as it does not have all the information
6069         mDNSPlatformMemZero(&mti, sizeof (mDNSTCPInfo));
6070         ret = mDNSPlatformRetrieveTCPInfo(&laddr, &lport, &raddr, &rport, &mti);
6071         if (ret != mStatus_NoError)
6072         {
6073             LogMsg("mDNSPlatformRetrieveTCPInfo: mDNSPlatformRetrieveTCPInfo failed %d", ret);
6074             return ret;
6075         }
6076         if ((intf != mDNSNULL) && (mti.IntfId != intf->InterfaceID))
6077         {
6078             LogInfo("mDNSPlatformRetrieveTCPInfo: InterfaceID  mismatch mti.IntfId = %p InterfaceID = %p",  mti.IntfId, intf->InterfaceID);
6079             return mStatus_BadParamErr;
6080         }
6081 
6082         if (laddr.type == mDNSAddrType_IPv4)
6083             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);
6084         else
6085             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);
6086     }
6087 
6088     // Did we insert a null byte at the end ?
6089     if (newrdlength == (sizeof(txt.c) - 1))
6090     {
6091         LogMsg("UpdateKeepaliveRData: could not allocate memory %s", ARDisplayString(m, rr));
6092         return mStatus_NoMemoryErr;
6093     }
6094 
6095     // Include the length for the null byte at the end
6096     txt.c[0] = newrdlength + 1;
6097     // Account for the first length byte and the null byte at the end
6098     newrdlength += 2;
6099 
6100     rdsize = newrdlength > sizeof(RDataBody) ? newrdlength : sizeof(RDataBody);
6101     newrd = mDNSPlatformMemAllocate(sizeof(RData) - sizeof(RDataBody) + rdsize);
6102     if (!newrd) { LogMsg("UpdateKeepaliveRData: ptr NULL"); return mStatus_NoMemoryErr; }
6103 
6104     newrd->MaxRDLength = (mDNSu16) rdsize;
6105     mDNSPlatformMemCopy(&newrd->u, txt.c, newrdlength);
6106 
6107     //  If we are updating the record for the first time, rdata points to rdatastorage as the rdata memory
6108     //  was allocated as part of the AuthRecord itself. We allocate memory when we update the AuthRecord.
6109     //  If the resource record has data that we allocated in a previous pass (to update MAC address),
6110     //  free that memory here before copying in the new data.
6111     if ( rr->resrec.rdata != &rr->rdatastorage)
6112     {
6113         LogSPS("UpdateKeepaliveRData: Freed allocated memory for keep alive packet: %s ", ARDisplayString(m, rr));
6114         mDNSPlatformMemFree(rr->resrec.rdata);
6115     }
6116     SetNewRData(&rr->resrec, newrd, newrdlength);    // Update our rdata
6117 
6118     LogSPS("UpdateKeepaliveRData: successfully updated the record %s", ARDisplayString(m, rr));
6119     return mStatus_NoError;
6120 }
6121 
6122 mDNSlocal void SendSPSRegistrationForOwner(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id, const OwnerOptData *const owner)
6123 {
6124     const int optspace = DNSOpt_Header_Space + DNSOpt_LeaseData_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC);
6125     const int sps = intf->NextSPSAttempt / 3;
6126     AuthRecord *rr;
6127     mDNSOpaque16 msgid;
6128     mDNSu32 scopeid;
6129 
6130     scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6131     if (!intf->SPSAddr[sps].type)
6132     {
6133         intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6134         if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
6135             m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
6136         LogSPS("SendSPSRegistration: %s SPS %d (%d) %##s not yet resolved", intf->ifname, intf->NextSPSAttempt, sps, intf->NetWakeResolve[sps].qname.c);
6137         goto exit;
6138     }
6139 
6140     // Mark our mDNS records (not unicast records) for transfer to SPS
6141     if (mDNSOpaque16IsZero(id))
6142     {
6143         // We may have to register this record over multiple interfaces and we don't want to
6144         // overwrite the id. We send the registration over interface X with id "IDX" and before
6145         // we get a response, we overwrite with id "IDY" for interface Y and we won't accept responses
6146         // for "IDX". Hence, we want to use the same ID across all interfaces.
6147         //
6148         // In the case of sleep proxy server transfering its records when it goes to sleep, the owner
6149         // option check below will set the same ID across the records from the same owner. Records
6150         // with different owner option gets different ID.
6151         msgid = mDNS_NewMessageID(m);
6152         for (rr = m->ResourceRecords; rr; rr=rr->next)
6153         {
6154             if (!(rr->AuthFlags & AuthFlagsWakeOnly) && rr->resrec.RecordType > kDNSRecordTypeDeregistering)
6155             {
6156                 if (rr->resrec.InterfaceID == intf->InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
6157                 {
6158                     if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6159                     {
6160                         rr->SendRNow = mDNSInterfaceMark;   // mark it now
6161                         // When we are registering on the first interface, rr->updateid is zero in which case
6162                         // initialize with the new ID. For subsequent interfaces, we want to use the same ID.
6163                         // At the end, all the updates sent across all the interfaces with the same ID.
6164                         if (mDNSOpaque16IsZero(rr->updateid))
6165                             rr->updateid = msgid;
6166                         else
6167                             msgid = rr->updateid;
6168                     }
6169                 }
6170             }
6171         }
6172     }
6173     else
6174         msgid = id;
6175 
6176     while (1)
6177     {
6178         mDNSu8 *p = m->omsg.data;
6179         // To comply with RFC 2782, PutResourceRecord suppresses name compression for SRV records in unicast updates.
6180         // For now we follow that same logic for SPS registrations too.
6181         // If we decide to compress SRV records in SPS registrations in the future, we can achieve that by creating our
6182         // initial DNSMessage with h.flags set to zero, and then update it to UpdateReqFlags right before sending the packet.
6183         InitializeDNSMessage(&m->omsg.h, msgid, UpdateReqFlags);
6184 
6185         for (rr = m->ResourceRecords; rr; rr=rr->next)
6186             if (rr->SendRNow || mDNSUpdateOkToSend(m, rr, intf, scopeid))
6187             {
6188                 if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6189                 {
6190                     mDNSu8 *newptr;
6191                     const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.mDNS_numUpdates ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData) - optspace;
6192 
6193                     // If we can't update the keepalive record, don't send it
6194                     if (mDNS_KeepaliveRecord(&rr->resrec) && (UpdateKeepaliveRData(m, rr, intf, mDNSfalse, mDNSNULL) != mStatus_NoError))
6195                     {
6196                         if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
6197                         {
6198                             bit_clr_opaque64(rr->updateIntID, scopeid);
6199                         }
6200                         rr->SendRNow = mDNSNULL;
6201                         continue;
6202                     }
6203 
6204                     if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
6205                         rr->resrec.rrclass |= kDNSClass_UniqueRRSet;    // Temporarily set the 'unique' bit so PutResourceRecord will set it
6206                     newptr = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.mDNS_numUpdates, &rr->resrec, rr->resrec.rroriginalttl, limit);
6207                     rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet;       // Make sure to clear 'unique' bit back to normal state
6208                     if (!newptr)
6209                         LogSPS("SendSPSRegistration put %s FAILED %d/%d %s", intf->ifname, p - m->omsg.data, limit - m->omsg.data, ARDisplayString(m, rr));
6210                     else
6211                     {
6212                         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));
6213                         rr->SendRNow       = mDNSNULL;
6214                         rr->ThisAPInterval = mDNSPlatformOneSecond;
6215                         rr->LastAPTime     = m->timenow;
6216                         // should be initialized above
6217                         if (mDNSOpaque16IsZero(rr->updateid)) LogMsg("SendSPSRegistration: ERROR!! rr %s updateid is zero", ARDisplayString(m, rr));
6218                         if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6219                             m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
6220                         p = newptr;
6221                     }
6222                 }
6223             }
6224 
6225         if (!m->omsg.h.mDNS_numUpdates) break;
6226         else
6227         {
6228             AuthRecord opt;
6229             mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
6230             opt.resrec.rrclass    = NormalMaxDNSMessageData;
6231             opt.resrec.rdlength   = sizeof(rdataOPT) * 2;   // Two options in this OPT record
6232             opt.resrec.rdestimate = sizeof(rdataOPT) * 2;
6233             opt.resrec.rdata->u.opt[0].opt           = kDNSOpt_Lease;
6234             opt.resrec.rdata->u.opt[0].optlen        = DNSOpt_LeaseData_Space - 4;
6235             opt.resrec.rdata->u.opt[0].u.updatelease = DEFAULT_UPDATE_LEASE;
6236             if (!owner->HMAC.l[0])                                          // If no owner data,
6237                 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[1]);        // use our own interface information
6238             else                                                            // otherwise, use the owner data we were given
6239             {
6240                 opt.resrec.rdata->u.opt[1].u.owner = *owner;
6241                 opt.resrec.rdata->u.opt[1].opt     = kDNSOpt_Owner;
6242                 opt.resrec.rdata->u.opt[1].optlen  = DNSOpt_Owner_Space(&owner->HMAC, &owner->IMAC) - 4;
6243             }
6244             LogSPS("SendSPSRegistration put %s %s", intf->ifname, ARDisplayString(m, &opt));
6245             p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
6246             if (!p)
6247                 LogMsg("SendSPSRegistration: Failed to put OPT record (%d updates) %s", m->omsg.h.mDNS_numUpdates, ARDisplayString(m, &opt));
6248             else
6249             {
6250                 mStatus err;
6251 
6252                 LogSPS("SendSPSRegistration: Sending Update %s %d (%d) id %5d with %d records %d bytes to %#a:%d", intf->ifname, intf->NextSPSAttempt, sps,
6253                        mDNSVal16(m->omsg.h.id), m->omsg.h.mDNS_numUpdates, p - m->omsg.data, &intf->SPSAddr[sps], mDNSVal16(intf->SPSPort[sps]));
6254                 // if (intf->NextSPSAttempt < 5) m->omsg.h.flags = zeroID;  // For simulating packet loss
6255                 err = mDNSSendDNSMessage(m, &m->omsg, p, intf->InterfaceID, mDNSNULL, &intf->SPSAddr[sps], intf->SPSPort[sps], mDNSNULL, mDNSNULL, mDNSfalse);
6256                 if (err) LogSPS("SendSPSRegistration: mDNSSendDNSMessage err %d", err);
6257                 if (err && intf->SPSAddr[sps].type == mDNSAddrType_IPv4 && intf->NetWakeResolve[sps].ThisQInterval == -1)
6258                 {
6259                     LogSPS("SendSPSRegistration %d %##s failed to send to IPv4 address; will try IPv6 instead", sps, intf->NetWakeResolve[sps].qname.c);
6260                     intf->NetWakeResolve[sps].qtype = kDNSType_AAAA;
6261                     mDNS_StartQuery_internal(m, &intf->NetWakeResolve[sps]);
6262                     return;
6263                 }
6264             }
6265         }
6266     }
6267 
6268     intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond * 10;     // If successful, update NextSPSAttemptTime
6269 
6270 exit:
6271     if (mDNSOpaque16IsZero(id) && intf->NextSPSAttempt < 8) intf->NextSPSAttempt++;
6272 }
6273 
6274 mDNSlocal mDNSBool RecordIsFirstOccurrenceOfOwner(mDNS *const m, const AuthRecord *const rr)
6275 {
6276     AuthRecord *ar;
6277     for (ar = m->ResourceRecords; ar && ar != rr; ar=ar->next)
6278         if (mDNSPlatformMemSame(&rr->WakeUp, &ar->WakeUp, sizeof(rr->WakeUp))) return mDNSfalse;
6279     return mDNStrue;
6280 }
6281 
6282 mDNSlocal void mDNSCoreStoreProxyRR(mDNS *const m, const mDNSInterfaceID InterfaceID, AuthRecord *const rr)
6283 {
6284     AuthRecord *newRR = mDNSPlatformMemAllocate(sizeof(AuthRecord));
6285 
6286     if (newRR == mDNSNULL)
6287     {
6288         LogSPS("%s : could not allocate memory for new resource record", __func__);
6289         return;
6290     }
6291 
6292     mDNSPlatformMemZero(newRR, sizeof(AuthRecord));
6293     mDNS_SetupResourceRecord(newRR, mDNSNULL, InterfaceID, rr->resrec.rrtype,
6294                              rr->resrec.rroriginalttl, rr->resrec.RecordType,
6295                              rr->ARType, mDNSNULL, mDNSNULL);
6296 
6297     AssignDomainName(&newRR->namestorage, &rr->namestorage);
6298     newRR->resrec.rdlength = DomainNameLength(rr->resrec.name);
6299     newRR->resrec.namehash = DomainNameHashValue(newRR->resrec.name);
6300     newRR->resrec.rrclass  = rr->resrec.rrclass;
6301 
6302     if (rr->resrec.rrtype == kDNSType_A)
6303     {
6304         newRR->resrec.rdata->u.ipv4 =  rr->resrec.rdata->u.ipv4;
6305     }
6306     else if (rr->resrec.rrtype == kDNSType_AAAA)
6307     {
6308         newRR->resrec.rdata->u.ipv6 = rr->resrec.rdata->u.ipv6;
6309     }
6310     SetNewRData(&newRR->resrec, mDNSNULL, 0);
6311 
6312     // Insert the new node at the head of the list.
6313     newRR->next        = m->SPSRRSet;
6314     m->SPSRRSet        = newRR;
6315     LogSPS("%s : Storing proxy record : %s ", __func__, ARDisplayString(m, rr));
6316 }
6317 
6318 // Some records are interface specific and some are not. The ones that are supposed to be registered
6319 // on multiple interfaces need to be initialized with all the valid interfaces on which it will be sent.
6320 // updateIntID bit field tells us on which interfaces we need to register this record. When we get an
6321 // ack from the sleep proxy server, we clear the interface bit. This way, we know when a record completes
6322 // registration on all the interfaces
6323 mDNSlocal void SPSInitRecordsBeforeUpdate(mDNS *const m, mDNSOpaque64 updateIntID, mDNSBool *WakeOnlyService)
6324 {
6325     AuthRecord *ar;
6326     LogSPS("SPSInitRecordsBeforeUpdate: UpdateIntID 0x%x 0x%x", updateIntID.l[1], updateIntID.l[0]);
6327 
6328     *WakeOnlyService = mDNSfalse;
6329 
6330     // Before we store the A and AAAA records that we are going to register with the sleep proxy,
6331     // make sure that the old sleep proxy records are removed.
6332     mDNSCoreFreeProxyRR(m);
6333 
6334     // For records that are registered only on a specific interface, mark only that bit as it will
6335     // never be registered on any other interface. For others, it should be sent on all interfaces.
6336     for (ar = m->ResourceRecords; ar; ar=ar->next)
6337     {
6338         ar->updateIntID = zeroOpaque64;
6339         ar->updateid    = zeroID;
6340         if (AuthRecord_uDNS(ar))
6341         {
6342             continue;
6343         }
6344         if (ar->AuthFlags & AuthFlagsWakeOnly)
6345         {
6346             if (ar->resrec.RecordType == kDNSRecordTypeShared && ar->RequireGoodbye)
6347             {
6348                 ar->ImmedAnswer = mDNSInterfaceMark;
6349                 *WakeOnlyService = mDNStrue;
6350                 continue;
6351             }
6352         }
6353         if (!ar->resrec.InterfaceID)
6354         {
6355             LogSPS("Setting scopeid (ALL) 0x%x 0x%x for %s", updateIntID.l[1], updateIntID.l[0], ARDisplayString(m, ar));
6356             ar->updateIntID = updateIntID;
6357         }
6358         else
6359         {
6360             // Filter records that belong to interfaces that we won't register the records on. UpdateIntID captures
6361             // exactly this.
6362             mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, ar->resrec.InterfaceID, mDNStrue);
6363             if ((scopeid < (sizeof(updateIntID) * mDNSNBBY)) && bit_get_opaque64(updateIntID, scopeid))
6364             {
6365                 bit_set_opaque64(ar->updateIntID, scopeid);
6366                 LogSPS("SPSInitRecordsBeforeUpdate: Setting scopeid(%d) 0x%x 0x%x for %s", scopeid, ar->updateIntID.l[1],
6367                     ar->updateIntID.l[0], ARDisplayString(m, ar));
6368             }
6369             else
6370             {
6371                 LogSPS("SPSInitRecordsBeforeUpdate: scopeid %d beyond range or not valid for SPS registration", scopeid);
6372             }
6373         }
6374         // Store the A and AAAA records that we registered with the sleep proxy.
6375         // We will use this to prevent spurious name conflicts that may occur when we wake up
6376         if (ar->resrec.rrtype == kDNSType_A || ar->resrec.rrtype == kDNSType_AAAA)
6377         {
6378             mDNSCoreStoreProxyRR(m, ar->resrec.InterfaceID, ar);
6379         }
6380     }
6381 }
6382 
6383 mDNSlocal void SendSPSRegistration(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id)
6384 {
6385     AuthRecord *ar;
6386     OwnerOptData owner = zeroOwner;
6387 
6388     SendSPSRegistrationForOwner(m, intf, id, &owner);
6389 
6390     for (ar = m->ResourceRecords; ar; ar=ar->next)
6391     {
6392         if (!mDNSPlatformMemSame(&owner, &ar->WakeUp, sizeof(owner)) && RecordIsFirstOccurrenceOfOwner(m, ar))
6393         {
6394             owner = ar->WakeUp;
6395             SendSPSRegistrationForOwner(m, intf, id, &owner);
6396         }
6397     }
6398 }
6399 
6400 // RetrySPSRegistrations is called from SendResponses, with the lock held
6401 mDNSlocal void RetrySPSRegistrations(mDNS *const m)
6402 {
6403     AuthRecord *rr;
6404     NetworkInterfaceInfo *intf;
6405 
6406     // First make sure none of our interfaces' NextSPSAttemptTimes are inadvertently set to m->timenow + mDNSPlatformOneSecond * 10
6407     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6408         if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10)
6409             intf->NextSPSAttemptTime++;
6410 
6411     // Retry any record registrations that are due
6412     for (rr = m->ResourceRecords; rr; rr=rr->next)
6413         if (!AuthRecord_uDNS(rr) && !mDNSOpaque16IsZero(rr->updateid) && m->timenow - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6414         {
6415             for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6416             {
6417                 // If we still have registrations pending on this interface, send it now
6418                 mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6419                 if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
6420                     (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
6421                 {
6422                     LogSPS("RetrySPSRegistrations: 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m, rr));
6423                     SendSPSRegistration(m, intf, rr->updateid);
6424                 }
6425             }
6426         }
6427 
6428     // For interfaces where we did an SPS registration attempt, increment intf->NextSPSAttempt
6429     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6430         if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10 && intf->NextSPSAttempt < 8)
6431             intf->NextSPSAttempt++;
6432 }
6433 
6434 mDNSlocal void NetWakeResolve(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
6435 {
6436     NetworkInterfaceInfo *intf = (NetworkInterfaceInfo *)question->QuestionContext;
6437     int sps = (int)(question - intf->NetWakeResolve);
6438     (void)m;            // Unused
6439     LogSPS("NetWakeResolve: SPS: %d Add: %d %s", sps, AddRecord, RRDisplayString(m, answer));
6440 
6441     if (!AddRecord) return;                                             // Don't care about REMOVE events
6442     if (answer->rrtype != question->qtype) return;                      // Don't care about CNAMEs
6443 
6444     // if (answer->rrtype == kDNSType_AAAA && sps == 0) return; // To test failing to resolve sleep proxy's address
6445 
6446     if (answer->rrtype == kDNSType_SRV)
6447     {
6448         // 1. Got the SRV record; now look up the target host's IP address
6449         mDNS_StopQuery(m, question);
6450         intf->SPSPort[sps] = answer->rdata->u.srv.port;
6451         AssignDomainName(&question->qname, &answer->rdata->u.srv.target);
6452         question->qtype = kDNSType_A;
6453         mDNS_StartQuery(m, question);
6454     }
6455     else if (answer->rrtype == kDNSType_A && answer->rdlength == sizeof(mDNSv4Addr))
6456     {
6457         // 2. Got an IPv4 address for the target host; record address and initiate an SPS registration if appropriate
6458         mDNS_StopQuery(m, question);
6459         question->ThisQInterval = -1;
6460         intf->SPSAddr[sps].type = mDNSAddrType_IPv4;
6461         intf->SPSAddr[sps].ip.v4 = answer->rdata->u.ipv4;
6462         mDNS_Lock(m);
6463         if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID);    // If we're ready for this result, use it now
6464         mDNS_Unlock(m);
6465     }
6466     else if (answer->rrtype == kDNSType_A && answer->rdlength == 0)
6467     {
6468         // 3. Got negative response -- target host apparently has IPv6 disabled -- so try looking up the target host's IPv4 address(es) instead
6469         mDNS_StopQuery(m, question);
6470         LogSPS("NetWakeResolve: SPS %d %##s has no IPv4 address, will try IPv6 instead", sps, question->qname.c);
6471         question->qtype = kDNSType_AAAA;
6472         mDNS_StartQuery(m, question);
6473     }
6474     else if (answer->rrtype == kDNSType_AAAA && answer->rdlength == sizeof(mDNSv6Addr) && mDNSv6AddressIsLinkLocal(&answer->rdata->u.ipv6))
6475     {
6476         // 4. Got the target host's IPv6 link-local address; record address and initiate an SPS registration if appropriate
6477         mDNS_StopQuery(m, question);
6478         question->ThisQInterval = -1;
6479         intf->SPSAddr[sps].type = mDNSAddrType_IPv6;
6480         intf->SPSAddr[sps].ip.v6 = answer->rdata->u.ipv6;
6481         mDNS_Lock(m);
6482         if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID);    // If we're ready for this result, use it now
6483         mDNS_Unlock(m);
6484     }
6485 }
6486 
6487 mDNSexport mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m)
6488 {
6489     AuthRecord *rr;
6490     for (rr = m->ResourceRecords; rr; rr=rr->next)
6491         if (mDNS_KeepaliveRecord(&rr->resrec) || (rr->resrec.rrtype == kDNSType_SRV && !AuthRecord_uDNS(rr) && !mDNSSameIPPort(rr->resrec.rdata->u.srv.port, DiscardPort)))
6492             return mDNStrue;
6493     return mDNSfalse;
6494 }
6495 
6496 #define WAKE_ONLY_SERVICE 1
6497 #define AC_ONLY_SERVICE   2
6498 
6499 #ifdef APPLE_OSX_mDNSResponder
6500 mDNSlocal void SendGoodbyesForSelectServices(mDNS *const m, mDNSBool *servicePresent, mDNSu32 serviceType)
6501 {
6502     AuthRecord *rr;
6503     *servicePresent = mDNSfalse;
6504 
6505     // Mark all the records we need to deregister and send them
6506     for (rr = m->ResourceRecords; rr; rr=rr->next)
6507     {
6508         // If the service type is wake only service and the auth flags match and requires a goodbye
6509         // OR if the service type is AC only and it is not a keepalive record,
6510         // mark the records we need to deregister and send them
6511         if ((serviceType == WAKE_ONLY_SERVICE && (rr->AuthFlags & AuthFlagsWakeOnly) &&
6512                 rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye) ||
6513             (serviceType == AC_ONLY_SERVICE && !mDNS_KeepaliveRecord(&rr->resrec)))
6514         {
6515             rr->ImmedAnswer = mDNSInterfaceMark;
6516             *servicePresent = mDNStrue;
6517         }
6518     }
6519 }
6520 #endif
6521 
6522 #ifdef APPLE_OSX_mDNSResponder
6523 // This function is used only in the case of local NIC proxy. For external
6524 // sleep proxy server, we do this in SPSInitRecordsBeforeUpdate when we
6525 // walk the resource records.
6526 mDNSlocal void SendGoodbyesForWakeOnlyService(mDNS *const m, mDNSBool *WakeOnlyService)
6527 {
6528     return SendGoodbyesForSelectServices(m, WakeOnlyService, WAKE_ONLY_SERVICE);
6529 }
6530 #endif // APPLE_OSX_mDNSResponder
6531 
6532 
6533 mDNSlocal void SendSleepGoodbyes(mDNS *const m, mDNSBool AllInterfaces, mDNSBool unicast)
6534 {
6535     AuthRecord *rr;
6536     m->SleepState = SleepState_Sleeping;
6537 
6538     // If AllInterfaces is not set, the caller has already marked it appropriately
6539     // on which interfaces this should be sent.
6540     if (AllInterfaces)
6541     {
6542         NetworkInterfaceInfo *intf;
6543         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6544         {
6545             intf->SendGoodbyes = 1;
6546         }
6547     }
6548     if (unicast)
6549     {
6550 #ifndef UNICAST_DISABLED
6551         SleepRecordRegistrations(m);    // If we have no SPS, need to deregister our uDNS records
6552 #endif /* UNICAST_DISABLED */
6553     }
6554 
6555     // Mark all the records we need to deregister and send them
6556     for (rr = m->ResourceRecords; rr; rr=rr->next)
6557         if (rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
6558             rr->ImmedAnswer = mDNSInterfaceMark;
6559     SendResponses(m);
6560 }
6561 
6562 /*
6563  * This function attempts to detect if multiple interfaces are on the same subnet.
6564  * It makes this determination based only on the IPv4 Addresses and subnet masks.
6565  * IPv6 link local addresses that are configured by default on all interfaces make
6566  * it hard to make this determination
6567  *
6568  * The 'real' fix for this would be to send out multicast packets over one interface
6569  * and conclude that multiple interfaces are on the same subnet only if these packets
6570  * are seen on other interfaces on the same system
6571  */
6572 mDNSlocal mDNSBool skipSameSubnetRegistration(mDNS *const m, mDNSInterfaceID *regID, mDNSu32 count, mDNSInterfaceID intfid)
6573 {
6574     NetworkInterfaceInfo *intf;
6575     NetworkInterfaceInfo *newIntf;
6576     mDNSu32 i;
6577 
6578     for (newIntf = FirstInterfaceForID(m, intfid); newIntf; newIntf = newIntf->next)
6579     {
6580         if ((newIntf->InterfaceID != intfid) ||
6581             (newIntf->ip.type     != mDNSAddrType_IPv4))
6582         {
6583             continue;
6584         }
6585         for ( i = 0; i < count; i++)
6586         {
6587             for (intf = FirstInterfaceForID(m, regID[i]); intf; intf = intf->next)
6588             {
6589                 if ((intf->InterfaceID != regID[i]) ||
6590                     (intf->ip.type     != mDNSAddrType_IPv4))
6591                 {
6592                     continue;
6593                 }
6594                 if ((intf->ip.ip.v4.NotAnInteger & intf->mask.ip.v4.NotAnInteger) == (newIntf->ip.ip.v4.NotAnInteger & newIntf->mask.ip.v4.NotAnInteger))
6595                 {
6596                     LogSPS("%s : Already registered for the same subnet (IPv4) for interface %s", __func__, intf->ifname);
6597                     return (mDNStrue);
6598                 }
6599             }
6600         }
6601     }
6602     return (mDNSfalse);
6603 }
6604 
6605 mDNSlocal void DoKeepaliveCallbacks(mDNS *m)
6606 {
6607     // Loop through the keepalive records and callback with an error
6608     m->CurrentRecord = m->ResourceRecords;
6609     while (m->CurrentRecord)
6610     {
6611         AuthRecord *const rr = m->CurrentRecord;
6612         if ((mDNS_KeepaliveRecord(&rr->resrec)) && (rr->resrec.RecordType != kDNSRecordTypeDeregistering))
6613         {
6614             LogSPS("DoKeepaliveCallbacks: Invoking the callback for %s", ARDisplayString(m, rr));
6615             if (rr->RecordCallback)
6616                 rr->RecordCallback(m, rr, mStatus_BadStateErr);
6617         }
6618         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
6619             m->CurrentRecord = rr->next;
6620     }
6621 }
6622 
6623 // BeginSleepProcessing is called, with the lock held, from either mDNS_Execute or mDNSCoreMachineSleep
6624 mDNSlocal void BeginSleepProcessing(mDNS *const m)
6625 {
6626     mDNSBool SendGoodbyes = mDNStrue;
6627     mDNSBool WakeOnlyService  = mDNSfalse;
6628     mDNSBool invokeKACallback = mDNStrue;
6629     const CacheRecord *sps[3] = { mDNSNULL };
6630     mDNSOpaque64 updateIntID = zeroOpaque64;
6631     mDNSInterfaceID registeredIntfIDS[128] = { 0 };
6632     mDNSu32 registeredCount = 0;
6633     int skippedRegistrations = 0;
6634 
6635     m->NextScheduledSPRetry = m->timenow;
6636 
6637     // Clear out the SCDynamic entry that stores the external SPS information
6638     mDNSPlatformClearSPSData();
6639 
6640     if      (!m->SystemWakeOnLANEnabled) LogSPS("BeginSleepProcessing: m->SystemWakeOnLANEnabled is false");
6641     else if (!mDNSCoreHaveAdvertisedMulticastServices(m)) LogSPS("BeginSleepProcessing: No advertised services");
6642     else    // If we have at least one advertised service
6643     {
6644         NetworkInterfaceInfo *intf;
6645         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6646         {
6647             // Intialize it to false. These values make sense only when SleepState is set to Sleeping.
6648             intf->SendGoodbyes = 0;
6649 
6650             // If it is not multicast capable, we could not have possibly discovered sleep proxy
6651             // servers.
6652             if (!intf->McastTxRx || mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
6653             {
6654                 LogSPS("BeginSleepProcessing: %-6s Ignoring for registrations", intf->ifname);
6655                 continue;
6656             }
6657 
6658             // If we are not capable of WOMP, then don't register with sleep proxy.
6659             //
6660             // Note: If we are not NetWake capable, we don't browse for the sleep proxy server.
6661             // We might find sleep proxy servers in the cache and start a resolve on them.
6662             // But then if the interface goes away, we won't stop these questions because
6663             // mDNS_DeactivateNetWake_internal assumes that a browse has been started for it
6664             // to stop both the browse and resolve questions.
6665             if (!intf->NetWake)
6666             {
6667                 LogSPS("BeginSleepProcessing: %-6s not capable of magic packet wakeup", intf->ifname);
6668                 intf->SendGoodbyes = 1;
6669                 skippedRegistrations++;
6670                 continue;
6671             }
6672 
6673             // Check if we have already registered with a sleep proxy for this subnet
6674             if (skipSameSubnetRegistration(m, registeredIntfIDS, registeredCount, intf->InterfaceID))
6675             {
6676                 LogSPS("%s : Skipping sleep proxy registration on %s", __func__, intf->ifname);
6677                 continue;
6678             }
6679 
6680 #if APPLE_OSX_mDNSResponder
6681             else if (SupportsInNICProxy(intf))
6682             {
6683                 mDNSBool keepaliveOnly = mDNSfalse;
6684                 if (ActivateLocalProxy(intf, &keepaliveOnly) == mStatus_NoError)
6685                 {
6686                     SendGoodbyesForWakeOnlyService(m, &WakeOnlyService);
6687 
6688                     // Send goodbyes for all advertised services if the only record offloaded was the keepalive record.
6689                     SendGoodbyes     = (keepaliveOnly) ? mDNStrue: mDNSfalse;
6690                     invokeKACallback = mDNSfalse;
6691                     LogSPS("BeginSleepProcessing: %-6s using local proxy", intf->ifname);
6692                     // This will leave m->SleepState set to SleepState_Transferring,
6693                     // which is okay because with no outstanding resolves, or updates in flight,
6694                     // mDNSCoreReadyForSleep() will conclude correctly that all the updates have already completed
6695 
6696                     // Setting this flag activates the SleepLimit which delays sleep by 5 seconds and
6697                     // will allow the system to deregister any BTMM records.
6698                     m->NextScheduledSPRetry  = m->timenow + (5 * mDNSPlatformOneSecond);
6699                     registeredIntfIDS[registeredCount] = intf->InterfaceID;
6700                     registeredCount++;
6701                 }
6702             }
6703 #endif // APPLE_OSX_mDNSResponder
6704             else
6705             {
6706 #if APPLE_OSX_mDNSResponder
6707                 // If on battery, do not attempt to offload to external sleep proxies
6708                 if (m->SystemWakeOnLANEnabled == mDNS_WakeOnBattery)
6709                 {
6710                     LogSPS("BegingSleepProcessing: Not connected to AC power - Not registering with an external sleep proxy.");
6711                     return;
6712                 }
6713 #endif // APPLE_OSX_mDNSResponder
6714                 FindSPSInCache(m, &intf->NetWakeBrowse, sps);
6715                 if (!sps[0]) LogSPS("BeginSleepProcessing: %-6s %#a No Sleep Proxy Server found (Next Browse Q in %d, interval %d)",
6716                                     intf->ifname, &intf->ip, NextQSendTime(&intf->NetWakeBrowse) - m->timenow, intf->NetWakeBrowse.ThisQInterval);
6717                 else
6718                 {
6719                     int i;
6720                     mDNSu32 scopeid;
6721                     SendGoodbyes = mDNSfalse;
6722                     intf->NextSPSAttempt = 0;
6723                     intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6724 
6725                     scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6726                     // Now we know for sure that we have to wait for registration to complete on this interface.
6727                     if (scopeid < (sizeof(updateIntID) * mDNSNBBY))
6728                         bit_set_opaque64(updateIntID, scopeid);
6729 
6730                     // Don't need to set m->NextScheduledSPRetry here because we already set "m->NextScheduledSPRetry = m->timenow" above
6731                     for (i=0; i<3; i++)
6732                     {
6733 #if ForceAlerts
6734                         if (intf->SPSAddr[i].type)
6735                             LogFatalError("BeginSleepProcessing: %s %d intf->SPSAddr[i].type %d", intf->ifname, i, intf->SPSAddr[i].type);
6736                         if (intf->NetWakeResolve[i].ThisQInterval >= 0)
6737                             LogFatalError("BeginSleepProcessing: %s %d intf->NetWakeResolve[i].ThisQInterval %d", intf->ifname, i, intf->NetWakeResolve[i].ThisQInterval);
6738 #endif
6739                         intf->SPSAddr[i].type = mDNSAddrType_None;
6740                         if (intf->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery(m, &intf->NetWakeResolve[i]);
6741                         intf->NetWakeResolve[i].ThisQInterval = -1;
6742                         if (sps[i])
6743                         {
6744                             LogSPS("BeginSleepProcessing: %-6s Found Sleep Proxy Server %d TTL %d %s", intf->ifname, i, sps[i]->resrec.rroriginalttl, CRDisplayString(m, sps[i]));
6745                             mDNS_SetupQuestion(&intf->NetWakeResolve[i], intf->InterfaceID, &sps[i]->resrec.rdata->u.name, kDNSType_SRV, NetWakeResolve, intf);
6746                             intf->NetWakeResolve[i].ReturnIntermed = mDNStrue;
6747                             mDNS_StartQuery_internal(m, &intf->NetWakeResolve[i]);
6748 
6749                             // If we are registering with a Sleep Proxy for a new subnet, add it to our list
6750                             registeredIntfIDS[registeredCount] = intf->InterfaceID;
6751                             registeredCount++;
6752                         }
6753                     }
6754                 }
6755             }
6756         }
6757     }
6758 
6759     // If we have at least one interface on which we are registering with an external sleep proxy,
6760     // initialize all the records appropriately.
6761     if (!mDNSOpaque64IsZero(&updateIntID))
6762         SPSInitRecordsBeforeUpdate(m, updateIntID, &WakeOnlyService);
6763 
6764     // Call the applicaitons that registered a keepalive record to inform them that we failed to offload
6765     // the records to a sleep proxy.
6766     if (invokeKACallback)
6767     {
6768         LogSPS("BeginSleepProcessing: Did not register with an in-NIC proxy - invoking the callbacks for KA records");
6769         DoKeepaliveCallbacks(m);
6770     }
6771 
6772     // SendSleepGoodbyes last two arguments control whether we send goodbyes on all
6773     // interfaces and also deregister unicast registrations.
6774     //
6775     // - If there are no sleep proxy servers, then send goodbyes on all interfaces
6776     //   for both multicast and unicast.
6777     //
6778     // - If we skipped registrations on some interfaces, then we have already marked
6779     //   them appropriately above. We don't need to send goodbyes for unicast as
6780     //   we have registered with at least one sleep proxy.
6781     //
6782     // - If we are not planning to send any goodbyes, then check for WakeOnlyServices.
6783     //
6784     // Note: If we are planning to send goodbyes, we mark the record with mDNSInterfaceAny
6785     // and call SendResponses which inturn calls ShouldSendGoodbyesBeforeSleep which looks
6786     // at WakeOnlyServices first.
6787     if (SendGoodbyes)
6788     {
6789         LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server");
6790         SendSleepGoodbyes(m, mDNStrue, mDNStrue);
6791     }
6792     else if (skippedRegistrations)
6793     {
6794         LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server on all interfaces");
6795         SendSleepGoodbyes(m, mDNSfalse, mDNSfalse);
6796     }
6797     else if (WakeOnlyService)
6798     {
6799         // If we saw WakeOnly service above, send the goodbyes now.
6800         LogSPS("BeginSleepProcessing: Sending goodbyes for WakeOnlyService");
6801         SendResponses(m);
6802     }
6803 }
6804 
6805 // Call mDNSCoreMachineSleep(m, mDNStrue) when the machine is about to go to sleep.
6806 // Call mDNSCoreMachineSleep(m, mDNSfalse) when the machine is has just woken up.
6807 // Normally, the platform support layer below mDNSCore should call this, not the client layer above.
6808 mDNSexport void mDNSCoreMachineSleep(mDNS *const m, mDNSBool sleep)
6809 {
6810     AuthRecord *rr;
6811 
6812     LogSPS("%s (old state %d) at %ld", sleep ? "Sleeping" : "Waking", m->SleepState, m->timenow);
6813 
6814     if (sleep && !m->SleepState)        // Going to sleep
6815     {
6816         mDNS_Lock(m);
6817         // If we're going to sleep, need to stop advertising that we're a Sleep Proxy Server
6818         if (m->SPSSocket)
6819         {
6820             mDNSu8 oldstate = m->SPSState;
6821             mDNS_DropLockBeforeCallback();      // mDNS_DeregisterService expects to be called without the lock held, so we emulate that here
6822             m->SPSState = 2;
6823 #ifndef SPC_DISABLED
6824             if (oldstate == 1) mDNS_DeregisterService(m, &m->SPSRecords);
6825 #else
6826             (void)oldstate;
6827 #endif
6828             mDNS_ReclaimLockAfterCallback();
6829         }
6830 
6831         m->SleepState = SleepState_Transferring;
6832         if (m->SystemWakeOnLANEnabled && m->DelaySleep)
6833         {
6834             // If we just woke up moments ago, allow ten seconds for networking to stabilize before going back to sleep
6835             LogSPS("mDNSCoreMachineSleep: Re-sleeping immediately after waking; will delay for %d ticks", m->DelaySleep - m->timenow);
6836             m->SleepLimit = NonZeroTime(m->DelaySleep + mDNSPlatformOneSecond * 10);
6837         }
6838         else
6839         {
6840             m->DelaySleep = 0;
6841             m->SleepLimit = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 10);
6842             m->mDNSStats.Sleeps++;
6843             BeginSleepProcessing(m);
6844         }
6845 
6846 #ifndef UNICAST_DISABLED
6847         SuspendLLQs(m);
6848 #endif
6849 #if APPLE_OSX_mDNSResponder
6850         RemoveAutoTunnel6Record(m);
6851 #endif
6852         LogSPS("mDNSCoreMachineSleep: m->SleepState %d (%s) seq %d", m->SleepState,
6853                m->SleepState == SleepState_Transferring ? "Transferring" :
6854                m->SleepState == SleepState_Sleeping     ? "Sleeping"     : "?", m->SleepSeqNum);
6855         mDNS_Unlock(m);
6856     }
6857     else if (!sleep)        // Waking up
6858     {
6859         mDNSu32 slot;
6860         CacheGroup *cg;
6861         CacheRecord *cr;
6862         NetworkInterfaceInfo *intf;
6863         mDNSs32 currtime, diff;
6864 
6865         mDNS_Lock(m);
6866         // Reset SleepLimit back to 0 now that we're awake again.
6867         m->SleepLimit = 0;
6868 
6869         // If we were previously sleeping, but now we're not, increment m->SleepSeqNum to indicate that we're entering a new period of wakefulness
6870         if (m->SleepState != SleepState_Awake)
6871         {
6872             m->SleepState = SleepState_Awake;
6873             m->SleepSeqNum++;
6874             // If the machine wakes and then immediately tries to sleep again (e.g. a maintenance wake)
6875             // then we enforce a minimum delay of five seconds before we begin sleep processing.
6876             // This is to allow time for the Ethernet link to come up, DHCP to get an address, mDNS to issue queries, etc.,
6877             // before we make our determination of whether there's a Sleep Proxy out there we should register with.
6878             m->DelaySleep = NonZeroTime(m->timenow + kDarkWakeDelaySleep);
6879         }
6880 
6881         if (m->SPSState == 3)
6882         {
6883             m->SPSState = 0;
6884             mDNSCoreBeSleepProxyServer_internal(m, m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags);
6885         }
6886         m->mDNSStats.Wakes++;
6887         m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
6888         // ... and the same for NextSPSAttempt
6889         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next)) intf->NextSPSAttempt = -1;
6890 
6891         // Restart unicast and multicast queries
6892         mDNSCoreRestartQueries(m);
6893 
6894         // and reactivtate service registrations
6895         m->NextSRVUpdate = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
6896         LogInfo("mDNSCoreMachineSleep waking: NextSRVUpdate in %d %d", m->NextSRVUpdate - m->timenow, m->timenow);
6897 
6898         // 2. Re-validate our cache records
6899         currtime = mDNSPlatformUTC();
6900 
6901         diff = currtime - m->TimeSlept;
6902         FORALL_CACHERECORDS(slot, cg, cr)
6903         {
6904             // Temporary fix: For unicast cache records, look at how much time we slept.
6905             // Adjust the RecvTime by the amount of time we slept so that we age the
6906             // cache record appropriately. If it is expired already, purge. If there
6907             // is a network change that happens after the wakeup, we might purge the
6908             // cache anyways and this helps only in the case where there are no network
6909             // changes across sleep/wakeup transition.
6910             //
6911             // Note: If there is a network/DNS server change that already happened and
6912             // these cache entries are already refreshed and we are getting a delayed
6913             // wake up notification, we might adjust the TimeRcvd based on the time slept
6914             // now which can cause the cache to purge pre-maturely. As this is not a very
6915             // common case, this should happen rarely.
6916             if (!cr->resrec.InterfaceID)
6917             {
6918                 if (diff > 0)
6919                 {
6920                     mDNSu32 uTTL = RRUnadjustedTTL(cr->resrec.rroriginalttl);
6921                     const mDNSs32 remain = uTTL - (m->timenow - cr->TimeRcvd) / mDNSPlatformOneSecond;
6922 
6923                     // -if we have slept longer than the remaining TTL, purge and start fresh.
6924                     // -if we have been sleeping for a long time, we could reduce TimeRcvd below by
6925                     //  a sufficiently big value which could cause the value to go into the future
6926                     //  because of the signed comparison of time. For this to happen, we should have been
6927                     //  sleeping really long (~24 days). For now, we want to be conservative and flush even
6928                     //  if we have slept for more than two days.
6929 
6930                     if (diff >= remain || diff > (2 * 24 * 3600))
6931                     {
6932                         LogInfo("mDNSCoreMachineSleep: %s: Purging cache entry SleptTime %d, Remaining TTL %d",
6933                             CRDisplayString(m, cr), diff, remain);
6934                         mDNS_PurgeCacheResourceRecord(m, cr);
6935                         continue;
6936                     }
6937                     cr->TimeRcvd -= (diff * mDNSPlatformOneSecond);
6938                     if (m->timenow - (cr->TimeRcvd + ((mDNSs32)uTTL * mDNSPlatformOneSecond)) >= 0)
6939                     {
6940                         LogInfo("mDNSCoreMachineSleep: %s: Purging after adjusting the remaining TTL %d by %d seconds",
6941                             CRDisplayString(m, cr), remain, diff);
6942                         mDNS_PurgeCacheResourceRecord(m, cr);
6943                     }
6944                     else
6945                     {
6946                         LogInfo("mDNSCoreMachineSleep: %s: Adjusted the remain ttl %u by %d seconds", CRDisplayString(m, cr), remain, diff);
6947                     }
6948                 }
6949             }
6950             else
6951             {
6952                 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForWake);
6953             }
6954         }
6955 
6956         // 3. Retrigger probing and announcing for all our authoritative records
6957         for (rr = m->ResourceRecords; rr; rr=rr->next)
6958         {
6959             if (AuthRecord_uDNS(rr))
6960             {
6961                 ActivateUnicastRegistration(m, rr);
6962             }
6963             else
6964             {
6965                 mDNSCoreRestartRegistration(m, rr, -1);
6966             }
6967         }
6968 
6969         // 4. Refresh NAT mappings
6970         // We don't want to have to assume that all hardware can necessarily keep accurate
6971         // track of passage of time while asleep, so on wake we refresh our NAT mappings.
6972         // We typically wake up with no interfaces active, so there's no need to rush to try to find our external address.
6973         // But if we do get a network configuration change, mDNSMacOSXNetworkChanged will call uDNS_SetupDNSConfig, which
6974         // will call mDNS_SetPrimaryInterfaceInfo, which will call RecreateNATMappings to refresh them, potentially sooner
6975         // than five seconds from now.
6976         LogInfo("mDNSCoreMachineSleep: recreating NAT mappings in 5 seconds");
6977         RecreateNATMappings(m, mDNSPlatformOneSecond * 5);
6978         mDNS_Unlock(m);
6979     }
6980 }
6981 
6982 mDNSexport mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now)
6983 {
6984     DNSQuestion *q;
6985     AuthRecord *rr;
6986     NetworkInterfaceInfo *intf;
6987 
6988     mDNS_Lock(m);
6989 
6990     if (m->DelaySleep) goto notready;
6991 
6992     // If we've not hit the sleep limit time, and it's not time for our next retry, we can skip these checks
6993     if (m->SleepLimit - now > 0 && m->NextScheduledSPRetry - now > 0) goto notready;
6994 
6995     m->NextScheduledSPRetry = now + 0x40000000UL;
6996 
6997     // See if we might need to retransmit any lost Sleep Proxy Registrations
6998     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6999         if (intf->NextSPSAttempt >= 0)
7000         {
7001             if (now - intf->NextSPSAttemptTime >= 0)
7002             {
7003                 LogSPS("mDNSCoreReadyForSleep: retrying for %s SPS %d try %d",
7004                        intf->ifname, intf->NextSPSAttempt/3, intf->NextSPSAttempt);
7005                 SendSPSRegistration(m, intf, zeroID);
7006                 // Don't need to "goto notready" here, because if we do still have record registrations
7007                 // that have not been acknowledged yet, we'll catch that in the record list scan below.
7008             }
7009             else
7010             if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
7011                 m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
7012         }
7013 
7014     // Scan list of interfaces, and see if we're still waiting for any sleep proxy resolves to complete
7015     for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7016     {
7017         int sps = (intf->NextSPSAttempt == 0) ? 0 : (intf->NextSPSAttempt-1)/3;
7018         if (intf->NetWakeResolve[sps].ThisQInterval >= 0)
7019         {
7020             LogSPS("mDNSCoreReadyForSleep: waiting for SPS Resolve %s %##s (%s)",
7021                    intf->ifname, intf->NetWakeResolve[sps].qname.c, DNSTypeName(intf->NetWakeResolve[sps].qtype));
7022             goto spsnotready;
7023         }
7024     }
7025 
7026     // Scan list of registered records
7027     for (rr = m->ResourceRecords; rr; rr = rr->next)
7028         if (!AuthRecord_uDNS(rr))
7029             if (!mDNSOpaque64IsZero(&rr->updateIntID))
7030             { 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; }
7031 
7032     // Scan list of private LLQs, and make sure they've all completed their handshake with the server
7033     for (q = m->Questions; q; q = q->next)
7034         if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->ReqLease == 0 && q->tcp)
7035         {
7036             LogSPS("mDNSCoreReadyForSleep: waiting for LLQ %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
7037             goto notready;
7038         }
7039 
7040     // Scan list of registered records
7041     for (rr = m->ResourceRecords; rr; rr = rr->next)
7042         if (AuthRecord_uDNS(rr))
7043         {
7044             if (rr->state == regState_Refresh && rr->tcp)
7045             { 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; }
7046             #if APPLE_OSX_mDNSResponder
7047             if (!RecordReadyForSleep(rr)) { LogSPS("mDNSCoreReadyForSleep: waiting for %s", ARDisplayString(m, rr)); goto notready; }
7048             #endif
7049         }
7050 
7051     mDNS_Unlock(m);
7052     return mDNStrue;
7053 
7054 spsnotready:
7055 
7056     // If we failed to complete sleep proxy registration within ten seconds, we give up on that
7057     // and allow up to ten seconds more to complete wide-area deregistration instead
7058     if (now - m->SleepLimit >= 0)
7059     {
7060         LogMsg("Failed to register with SPS, now sending goodbyes");
7061 
7062         for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7063             if (intf->NetWakeBrowse.ThisQInterval >= 0)
7064             {
7065                 LogSPS("ReadyForSleep mDNS_DeactivateNetWake %s %##s (%s)",
7066                        intf->ifname, intf->NetWakeResolve[0].qname.c, DNSTypeName(intf->NetWakeResolve[0].qtype));
7067                 mDNS_DeactivateNetWake_internal(m, intf);
7068             }
7069 
7070         for (rr = m->ResourceRecords; rr; rr = rr->next)
7071             if (!AuthRecord_uDNS(rr))
7072                 if (!mDNSOpaque64IsZero(&rr->updateIntID))
7073                 {
7074                     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));
7075                     rr->updateIntID = zeroOpaque64;
7076                 }
7077 
7078         // We'd really like to allow up to ten seconds more here,
7079         // but if we don't respond to the sleep notification within 30 seconds
7080         // we'll be put back to sleep forcibly without the chance to schedule the next maintenance wake.
7081         // Right now we wait 16 sec after wake for all the interfaces to come up, then we wait up to 10 seconds
7082         // more for SPS resolves and record registrations to complete, which puts us at 26 seconds.
7083         // If we allow just one more second to send our goodbyes, that puts us at 27 seconds.
7084         m->SleepLimit = now + mDNSPlatformOneSecond * 1;
7085 
7086         SendSleepGoodbyes(m, mDNStrue, mDNStrue);
7087     }
7088 
7089 notready:
7090     mDNS_Unlock(m);
7091     return mDNSfalse;
7092 }
7093 
7094 mDNSexport mDNSs32 mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now)
7095 {
7096     AuthRecord *ar;
7097 
7098     // Even when we have no wake-on-LAN-capable interfaces, or we failed to find a sleep proxy, or we have other
7099     // failure scenarios, we still want to wake up in at most 120 minutes, to see if the network environment has changed.
7100     // E.g. we might wake up and find no wireless network because the base station got rebooted just at that moment,
7101     // and if that happens we don't want to just give up and go back to sleep and never try again.
7102     mDNSs32 e = now + (120 * 60 * mDNSPlatformOneSecond);       // Sleep for at most 120 minutes
7103 
7104     NATTraversalInfo *nat;
7105     for (nat = m->NATTraversals; nat; nat=nat->next)
7106         if (nat->Protocol && nat->ExpiryTime && nat->ExpiryTime - now > mDNSPlatformOneSecond*4)
7107         {
7108             mDNSs32 t = nat->ExpiryTime - (nat->ExpiryTime - now) / 10;     // Wake up when 90% of the way to the expiry time
7109             if (e - t > 0) e = t;
7110             LogSPS("ComputeWakeTime: %p %s Int %5d Ext %5d Err %d Retry %5d Interval %5d Expire %5d Wake %5d",
7111                    nat, nat->Protocol == NATOp_MapTCP ? "TCP" : "UDP",
7112                    mDNSVal16(nat->IntPort), mDNSVal16(nat->ExternalPort), nat->Result,
7113                    nat->retryPortMap ? (nat->retryPortMap - now) / mDNSPlatformOneSecond : 0,
7114                    nat->retryInterval / mDNSPlatformOneSecond,
7115                    nat->ExpiryTime ? (nat->ExpiryTime - now) / mDNSPlatformOneSecond : 0,
7116                    (t - now) / mDNSPlatformOneSecond);
7117         }
7118 
7119     // This loop checks both the time we need to renew wide-area registrations,
7120     // and the time we need to renew Sleep Proxy registrations
7121     for (ar = m->ResourceRecords; ar; ar = ar->next)
7122         if (ar->expire && ar->expire - now > mDNSPlatformOneSecond*4)
7123         {
7124             mDNSs32 t = ar->expire - (ar->expire - now) / 10;       // Wake up when 90% of the way to the expiry time
7125             if (e - t > 0) e = t;
7126             LogSPS("ComputeWakeTime: %p Int %7d Next %7d Expire %7d Wake %7d %s",
7127                    ar, ar->ThisAPInterval / mDNSPlatformOneSecond,
7128                    (ar->LastAPTime + ar->ThisAPInterval - now) / mDNSPlatformOneSecond,
7129                    ar->expire ? (ar->expire - now) / mDNSPlatformOneSecond : 0,
7130                    (t - now) / mDNSPlatformOneSecond, ARDisplayString(m, ar));
7131         }
7132 
7133     return(e - now);
7134 }
7135 
7136 // ***************************************************************************
7137 #if COMPILER_LIKES_PRAGMA_MARK
7138 #pragma mark -
7139 #pragma mark - Packet Reception Functions
7140 #endif
7141 
7142 #define MustSendRecord(RR) ((RR)->NR_AnswerTo || (RR)->NR_AdditionalTo)
7143 
7144 mDNSlocal mDNSu8 *GenerateUnicastResponse(const DNSMessage *const query, const mDNSu8 *const end,
7145                                           const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, DNSMessage *const response, AuthRecord *ResponseRecords)
7146 {
7147     mDNSu8          *responseptr     = response->data;
7148     const mDNSu8    *const limit     = response->data + sizeof(response->data);
7149     const mDNSu8    *ptr             = query->data;
7150     AuthRecord  *rr;
7151     mDNSu32 maxttl = 0x70000000;
7152     int i;
7153 
7154     // Initialize the response fields so we can answer the questions
7155     InitializeDNSMessage(&response->h, query->h.id, ResponseFlags);
7156 
7157     // ***
7158     // *** 1. Write out the list of questions we are actually going to answer with this packet
7159     // ***
7160     if (LegacyQuery)
7161     {
7162         maxttl = kStaticCacheTTL;
7163         for (i=0; i<query->h.numQuestions; i++)                     // For each question...
7164         {
7165             DNSQuestion q;
7166             ptr = getQuestion(query, ptr, end, InterfaceID, &q);    // get the question...
7167             if (!ptr) return(mDNSNULL);
7168 
7169             for (rr=ResponseRecords; rr; rr=rr->NextResponse)       // and search our list of proposed answers
7170             {
7171                 if (rr->NR_AnswerTo == ptr)                         // If we're going to generate a record answering this question
7172                 {                                                   // then put the question in the question section
7173                     responseptr = putQuestion(response, responseptr, limit, &q.qname, q.qtype, q.qclass);
7174                     if (!responseptr) { debugf("GenerateUnicastResponse: Ran out of space for questions!"); return(mDNSNULL); }
7175                     break;      // break out of the ResponseRecords loop, and go on to the next question
7176                 }
7177             }
7178         }
7179 
7180         if (response->h.numQuestions == 0) { LogMsg("GenerateUnicastResponse: ERROR! Why no questions?"); return(mDNSNULL); }
7181     }
7182 
7183     // ***
7184     // *** 2. Write Answers
7185     // ***
7186     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7187         if (rr->NR_AnswerTo)
7188         {
7189             mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAnswers, &rr->resrec,
7190                                              maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7191             if (p) responseptr = p;
7192             else { debugf("GenerateUnicastResponse: Ran out of space for answers!"); response->h.flags.b[0] |= kDNSFlag0_TC; }
7193         }
7194 
7195     // ***
7196     // *** 3. Write Additionals
7197     // ***
7198     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7199         if (rr->NR_AdditionalTo && !rr->NR_AnswerTo)
7200         {
7201             mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAdditionals, &rr->resrec,
7202                                              maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7203             if (p) responseptr = p;
7204             else debugf("GenerateUnicastResponse: No more space for additionals");
7205         }
7206 
7207     return(responseptr);
7208 }
7209 
7210 // AuthRecord *our is our Resource Record
7211 // CacheRecord *pkt is the Resource Record from the response packet we've witnessed on the network
7212 // Returns 0 if there is no conflict
7213 // Returns +1 if there was a conflict and we won
7214 // Returns -1 if there was a conflict and we lost and have to rename
7215 mDNSlocal int CompareRData(const AuthRecord *const our, const CacheRecord *const pkt)
7216 {
7217     mDNSu8 ourdata[256], *ourptr = ourdata, *ourend;
7218     mDNSu8 pktdata[256], *pktptr = pktdata, *pktend;
7219     if (!our) { LogMsg("CompareRData ERROR: our is NULL"); return(+1); }
7220     if (!pkt) { LogMsg("CompareRData ERROR: pkt is NULL"); return(+1); }
7221 
7222     ourend = putRData(mDNSNULL, ourdata, ourdata + sizeof(ourdata), &our->resrec);
7223     pktend = putRData(mDNSNULL, pktdata, pktdata + sizeof(pktdata), &pkt->resrec);
7224     while (ourptr < ourend && pktptr < pktend && *ourptr == *pktptr) { ourptr++; pktptr++; }
7225     if (ourptr >= ourend && pktptr >= pktend) return(0);            // If data identical, not a conflict
7226 
7227     if (ourptr >= ourend) return(-1);                               // Our data ran out first; We lost
7228     if (pktptr >= pktend) return(+1);                               // Packet data ran out first; We won
7229     if (*pktptr > *ourptr) return(-1);                              // Our data is numerically lower; We lost
7230     if (*pktptr < *ourptr) return(+1);                              // Packet data is numerically lower; We won
7231 
7232     LogMsg("CompareRData ERROR: Invalid state");
7233     return(-1);
7234 }
7235 
7236 // See if we have an authoritative record that's identical to this packet record,
7237 // whose canonical DependentOn record is the specified master record.
7238 // The DependentOn pointer is typically used for the TXT record of service registrations
7239 // It indicates that there is no inherent conflict detection for the TXT record
7240 // -- it depends on the SRV record to resolve name conflicts
7241 // If we find any identical ResourceRecords in our authoritative list, then follow their DependentOn
7242 // pointer chain (if any) to make sure we reach the canonical DependentOn record
7243 // If the record has no DependentOn, then just return that record's pointer
7244 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7245 mDNSlocal mDNSBool MatchDependentOn(const mDNS *const m, const CacheRecord *const pktrr, const AuthRecord *const master)
7246 {
7247     const AuthRecord *r1;
7248     for (r1 = m->ResourceRecords; r1; r1=r1->next)
7249     {
7250         if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7251         {
7252             const AuthRecord *r2 = r1;
7253             while (r2->DependentOn) r2 = r2->DependentOn;
7254             if (r2 == master) return(mDNStrue);
7255         }
7256     }
7257     for (r1 = m->DuplicateRecords; r1; r1=r1->next)
7258     {
7259         if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7260         {
7261             const AuthRecord *r2 = r1;
7262             while (r2->DependentOn) r2 = r2->DependentOn;
7263             if (r2 == master) return(mDNStrue);
7264         }
7265     }
7266     return(mDNSfalse);
7267 }
7268 
7269 // Find the canonical RRSet pointer for this RR received in a packet.
7270 // If we find any identical AuthRecord in our authoritative list, then follow its RRSet
7271 // pointers (if any) to make sure we return the canonical member of this name/type/class
7272 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7273 mDNSlocal const AuthRecord *FindRRSet(const mDNS *const m, const CacheRecord *const pktrr)
7274 {
7275     const AuthRecord *rr;
7276     for (rr = m->ResourceRecords; rr; rr=rr->next)
7277     {
7278         if (IdenticalResourceRecord(&rr->resrec, &pktrr->resrec))
7279         {
7280             while (rr->RRSet && rr != rr->RRSet) rr = rr->RRSet;
7281             return(rr);
7282         }
7283     }
7284     return(mDNSNULL);
7285 }
7286 
7287 // PacketRRConflict is called when we've received an RR (pktrr) which has the same name
7288 // as one of our records (our) but different rdata.
7289 // 1. If our record is not a type that's supposed to be unique, we don't care.
7290 // 2a. If our record is marked as dependent on some other record for conflict detection, ignore this one.
7291 // 2b. If the packet rr exactly matches one of our other RRs, and *that* record's DependentOn pointer
7292 //     points to our record, ignore this conflict (e.g. the packet record matches one of our
7293 //     TXT records, and that record is marked as dependent on 'our', its SRV record).
7294 // 3. If we have some *other* RR that exactly matches the one from the packet, and that record and our record
7295 //    are members of the same RRSet, then this is not a conflict.
7296 mDNSlocal mDNSBool PacketRRConflict(const mDNS *const m, const AuthRecord *const our, const CacheRecord *const pktrr)
7297 {
7298     // If not supposed to be unique, not a conflict
7299     if (!(our->resrec.RecordType & kDNSRecordTypeUniqueMask)) return(mDNSfalse);
7300 
7301     // If a dependent record, not a conflict
7302     if (our->DependentOn || MatchDependentOn(m, pktrr, our)) return(mDNSfalse);
7303     else
7304     {
7305         // If the pktrr matches a member of ourset, not a conflict
7306         const AuthRecord *ourset = our->RRSet ? our->RRSet : our;
7307         const AuthRecord *pktset = FindRRSet(m, pktrr);
7308         if (pktset == ourset) return(mDNSfalse);
7309 
7310         // For records we're proxying, where we don't know the full
7311         // relationship between the records, having any matching record
7312         // in our AuthRecords list is sufficient evidence of non-conflict
7313         if (our->WakeUp.HMAC.l[0] && pktset) return(mDNSfalse);
7314     }
7315 
7316     // Okay, this is a conflict
7317     return(mDNStrue);
7318 }
7319 
7320 // Note: ResolveSimultaneousProbe calls mDNS_Deregister_internal which can call a user callback, which may change
7321 // the record list and/or question list.
7322 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
7323 mDNSlocal void ResolveSimultaneousProbe(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7324                                         DNSQuestion *q, AuthRecord *our)
7325 {
7326     int i;
7327     const mDNSu8 *ptr = LocateAuthorities(query, end);
7328     mDNSBool FoundUpdate = mDNSfalse;
7329 
7330     for (i = 0; i < query->h.numAuthorities; i++)
7331     {
7332         ptr = GetLargeResourceRecord(m, query, ptr, end, q->InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
7333         if (!ptr) break;
7334         if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7335         {
7336             FoundUpdate = mDNStrue;
7337             if (PacketRRConflict(m, our, &m->rec.r))
7338             {
7339                 int result          = (int)our->resrec.rrclass - (int)m->rec.r.resrec.rrclass;
7340                 if (!result) result = (int)our->resrec.rrtype  - (int)m->rec.r.resrec.rrtype;
7341                 if (!result) result = CompareRData(our, &m->rec.r);
7342                 if (result)
7343                 {
7344                     const char *const msg = (result < 0) ? "lost:" : (result > 0) ? "won: " : "tie: ";
7345                     LogMsg("ResolveSimultaneousProbe: %p Pkt Record:        %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7346                     LogMsg("ResolveSimultaneousProbe: %p Our Record %d %s %08lX %s", our->resrec.InterfaceID, our->ProbeCount, msg, our->resrec.rdatahash, ARDisplayString(m, our));
7347                 }
7348                 // 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.
7349                 // Instead we pause for one second, to give the other host (if real) a chance to establish its name, and then try probing again.
7350                 // If there really is another live host out there with the same name, it will answer our probes and we'll then rename.
7351                 if (result < 0)
7352                 {
7353                     m->SuppressProbes   = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
7354                     our->ProbeCount     = DefaultProbeCountForTypeUnique;
7355                     our->AnnounceCount  = InitialAnnounceCount;
7356                     InitializeLastAPTime(m, our);
7357                     goto exit;
7358                 }
7359             }
7360 #if 0
7361             else
7362             {
7363                 LogMsg("ResolveSimultaneousProbe: %p Pkt Record:        %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7364                 LogMsg("ResolveSimultaneousProbe: %p Our Record %d ign:  %08lX %s", our->resrec.InterfaceID, our->ProbeCount, our->resrec.rdatahash, ARDisplayString(m, our));
7365             }
7366 #endif
7367         }
7368         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7369     }
7370     if (!FoundUpdate)
7371         LogInfo("ResolveSimultaneousProbe: %##s (%s): No Update Record found", our->resrec.name->c, DNSTypeName(our->resrec.rrtype));
7372 exit:
7373     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7374 }
7375 
7376 mDNSlocal CacheRecord *FindIdenticalRecordInCache(const mDNS *const m, const ResourceRecord *const pktrr)
7377 {
7378     CacheGroup *cg = CacheGroupForRecord(m, pktrr);
7379     CacheRecord *rr;
7380     mDNSBool match;
7381     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
7382     {
7383         if (!pktrr->InterfaceID)
7384         {
7385             mDNSu16 id1 = (pktrr->rDNSServer ? pktrr->rDNSServer->resGroupID : 0);
7386             mDNSu16 id2 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
7387             match = (id1 == id2);
7388         }
7389         else match = (pktrr->InterfaceID == rr->resrec.InterfaceID);
7390 
7391         if (match && IdenticalSameNameRecord(pktrr, &rr->resrec)) break;
7392     }
7393     return(rr);
7394 }
7395 mDNSlocal void DeregisterProxyRecord(mDNS *const m, AuthRecord *const rr)
7396 {
7397     rr->WakeUp.HMAC    = zeroEthAddr; // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7398     rr->RequireGoodbye = mDNSfalse;   // and we don't want to send goodbye for it
7399     mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7400     SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7401 }
7402 
7403 mDNSlocal void ClearKeepaliveProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist, const mDNSInterfaceID InterfaceID)
7404 {
7405     if (m->CurrentRecord)
7406         LogMsg("ClearKeepaliveProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7407     m->CurrentRecord = thelist;
7408 
7409     // Normally, the RDATA of the keepalive record will be different each time and hence we always
7410     // clean up the keepalive record.
7411     while (m->CurrentRecord)
7412     {
7413         AuthRecord *const rr = m->CurrentRecord;
7414         if (InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7415         {
7416             if (mDNS_KeepaliveRecord(&m->rec.r.resrec))
7417             {
7418                 LogSPS("ClearKeepaliveProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7419                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7420                 DeregisterProxyRecord(m, rr);
7421             }
7422         }
7423         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7424         // new records could have been added to the end of the list as a result of that call.
7425         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7426             m->CurrentRecord = rr->next;
7427     }
7428 }
7429 
7430 // Called from mDNSCoreReceiveUpdate when we get a sleep proxy registration request,
7431 // to check our lists and discard any stale duplicates of this record we already have
7432 mDNSlocal void ClearIdenticalProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7433 {
7434     if (m->CurrentRecord)
7435         LogMsg("ClearIdenticalProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7436     m->CurrentRecord = thelist;
7437     while (m->CurrentRecord)
7438     {
7439         AuthRecord *const rr = m->CurrentRecord;
7440         if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7441             if (IdenticalResourceRecord(&rr->resrec, &m->rec.r.resrec))
7442             {
7443                 LogSPS("ClearIdenticalProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7444                        m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7445                 DeregisterProxyRecord(m, rr);
7446             }
7447         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7448         // new records could have been added to the end of the list as a result of that call.
7449         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7450             m->CurrentRecord = rr->next;
7451     }
7452 }
7453 
7454 // Called from ProcessQuery when we get an mDNS packet with an owner record in it
7455 mDNSlocal void ClearProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7456 {
7457     if (m->CurrentRecord)
7458         LogMsg("ClearProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7459     m->CurrentRecord = thelist;
7460     while (m->CurrentRecord)
7461     {
7462         AuthRecord *const rr = m->CurrentRecord;
7463         if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7464             if (owner->seq != rr->WakeUp.seq || m->timenow - rr->TimeRcvd > mDNSPlatformOneSecond * 60)
7465             {
7466                 if (rr->AddressProxy.type == mDNSAddrType_IPv6)
7467                 {
7468                     // We don't do this here because we know that the host is waking up at this point, so we don't send
7469                     // Unsolicited Neighbor Advertisements -- even Neighbor Advertisements agreeing with what the host should be
7470                     // saying itself -- because it can cause some IPv6 stacks to falsely conclude that there's an address conflict.
7471                     #if MDNS_USE_Unsolicited_Neighbor_Advertisements
7472                     LogSPS("NDP Announcement -- Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
7473                            &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
7474                     SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, &rr->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
7475                     #endif
7476                 }
7477                 LogSPS("ClearProxyRecords: Removing %3d AC %2d %02X H-MAC %.6a I-MAC %.6a %d %d %s",
7478                        m->ProxyRecords, rr->AnnounceCount, rr->resrec.RecordType,
7479                        &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7480                 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) rr->resrec.RecordType = kDNSRecordTypeShared;
7481                 rr->WakeUp.HMAC = zeroEthAddr;  // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7482                 rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it, since real host is now back and functional
7483                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7484                 SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7485             }
7486         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7487         // new records could have been added to the end of the list as a result of that call.
7488         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7489             m->CurrentRecord = rr->next;
7490     }
7491 }
7492 
7493 // ProcessQuery examines a received query to see if we have any answers to give
7494 mDNSlocal mDNSu8 *ProcessQuery(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7495                                const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, mDNSBool QueryWasMulticast,
7496                                mDNSBool QueryWasLocalUnicast, DNSMessage *const response)
7497 {
7498     mDNSBool FromLocalSubnet    = srcaddr && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
7499     AuthRecord   *ResponseRecords    = mDNSNULL;
7500     AuthRecord  **nrp                = &ResponseRecords;
7501 
7502 #if POOF_ENABLED
7503     CacheRecord  *ExpectedAnswers    = mDNSNULL;            // Records in our cache we expect to see updated
7504     CacheRecord **eap                = &ExpectedAnswers;
7505 #endif // POOF_ENABLED
7506 
7507     DNSQuestion  *DupQuestions       = mDNSNULL;            // Our questions that are identical to questions in this packet
7508     DNSQuestion **dqp                = &DupQuestions;
7509     mDNSs32 delayresponse      = 0;
7510     mDNSBool SendLegacyResponse = mDNSfalse;
7511     const mDNSu8 *ptr;
7512     mDNSu8       *responseptr        = mDNSNULL;
7513     AuthRecord   *rr;
7514     int i;
7515     CacheRecord *McastNSEC3Records   = mDNSNULL;
7516 
7517     // ***
7518     // *** 1. Look in Additional Section for an OPT record
7519     // ***
7520     ptr = LocateOptRR(query, end, DNSOpt_OwnerData_ID_Space);
7521     if (ptr)
7522     {
7523         ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAdd, &m->rec);
7524         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
7525         {
7526             const rdataOPT *opt;
7527             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
7528             // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
7529             // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
7530             for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
7531                 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
7532                 {
7533                     ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
7534                     ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
7535                 }
7536         }
7537         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7538     }
7539 
7540     //
7541     // Look in Authority Section for NSEC3 record
7542     //
7543 
7544     mDNSParseNSEC3Records(m, query, end, InterfaceID, &McastNSEC3Records);
7545 
7546     // ***
7547     // *** 2. Parse Question Section and mark potential answers
7548     // ***
7549     ptr = query->data;
7550     for (i=0; i<query->h.numQuestions; i++)                     // For each question...
7551     {
7552         mDNSBool QuestionNeedsMulticastResponse;
7553         int NumAnswersForThisQuestion = 0;
7554         AuthRecord *NSECAnswer = mDNSNULL;
7555         DNSQuestion pktq, *q;
7556         ptr = getQuestion(query, ptr, end, InterfaceID, &pktq); // get the question...
7557         if (!ptr) goto exit;
7558 
7559         pktq.AnonInfo = mDNSNULL;
7560         if (McastNSEC3Records)
7561             InitializeAnonInfoForQuestion(m, &McastNSEC3Records, &pktq);
7562         // The only queries that *need* a multicast response are:
7563         // * Queries sent via multicast
7564         // * from port 5353
7565         // * that don't have the kDNSQClass_UnicastResponse bit set
7566         // These queries need multicast responses because other clients will:
7567         // * suppress their own identical questions when they see these questions, and
7568         // * expire their cache records if they don't see the expected responses
7569         // For other queries, we may still choose to send the occasional multicast response anyway,
7570         // to keep our neighbours caches warm, and for ongoing conflict detection.
7571         QuestionNeedsMulticastResponse = QueryWasMulticast && !LegacyQuery && !(pktq.qclass & kDNSQClass_UnicastResponse);
7572 
7573         if (pktq.qclass & kDNSQClass_UnicastResponse)
7574             m->mDNSStats.UnicastBitInQueries++;
7575         else
7576             m->mDNSStats.NormalQueries++;
7577 
7578         // Clear the UnicastResponse flag -- don't want to confuse the rest of the code that follows later
7579         pktq.qclass &= ~kDNSQClass_UnicastResponse;
7580 
7581         // Note: We use the m->CurrentRecord mechanism here because calling ResolveSimultaneousProbe
7582         // can result in user callbacks which may change the record list and/or question list.
7583         // Also note: we just mark potential answer records here, without trying to build the
7584         // "ResponseRecords" list, because we don't want to risk user callbacks deleting records
7585         // from that list while we're in the middle of trying to build it.
7586         if (m->CurrentRecord)
7587             LogMsg("ProcessQuery ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7588         m->CurrentRecord = m->ResourceRecords;
7589         while (m->CurrentRecord)
7590         {
7591             rr = m->CurrentRecord;
7592             m->CurrentRecord = rr->next;
7593             if (AnyTypeRecordAnswersQuestion(&rr->resrec, &pktq) && (QueryWasMulticast || QueryWasLocalUnicast || rr->AllowRemoteQuery))
7594             {
7595                 m->mDNSStats.MatchingAnswersForQueries++;
7596                 if (RRTypeAnswersQuestionType(&rr->resrec, pktq.qtype))
7597                 {
7598                     if (rr->resrec.RecordType == kDNSRecordTypeUnique)
7599                         ResolveSimultaneousProbe(m, query, end, &pktq, rr);
7600                     else if (ResourceRecordIsValidAnswer(rr))
7601                     {
7602                         NumAnswersForThisQuestion++;
7603                         // As we have verified this question to be part of the same subset,
7604                         // set the anonymous data which is needed below when walk the cache
7605                         // records to see what answers we should be expecting. The cache records
7606                         // may cache only the nsec3RR and not the anonymous data itself.
7607                         if (pktq.AnonInfo && rr->resrec.AnonInfo)
7608                             SetAnonData(&pktq, &rr->resrec, mDNStrue);
7609 
7610                         // Note: We should check here if this is a probe-type query, and if so, generate an immediate
7611                         // unicast answer back to the source, because timeliness in answering probes is important.
7612 
7613                         // Notes:
7614                         // NR_AnswerTo pointing into query packet means "answer via immediate legacy unicast" (may *also* choose to multicast)
7615                         // NR_AnswerTo == NR_AnswerUnicast   means "answer via delayed unicast" (to modern querier; may promote to multicast instead)
7616                         // NR_AnswerTo == NR_AnswerMulticast means "definitely answer via multicast" (can't downgrade to unicast later)
7617                         // If we're not multicasting this record because the kDNSQClass_UnicastResponse bit was set,
7618                         // but the multicast querier is not on a matching subnet (e.g. because of overlaid subnets on one link)
7619                         // then we'll multicast it anyway (if we unicast, the receiver will ignore it because it has an apparently non-local source)
7620                         if (QuestionNeedsMulticastResponse || (!FromLocalSubnet && QueryWasMulticast && !LegacyQuery))
7621                         {
7622                             // We only mark this question for sending if it is at least one second since the last time we multicast it
7623                             // on this interface. If it is more than a second, or LastMCInterface is different, then we may multicast it.
7624                             // This is to guard against the case where someone blasts us with queries as fast as they can.
7625                             if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)mDNSPlatformOneSecond ||
7626                                 (rr->LastMCInterface != mDNSInterfaceMark && rr->LastMCInterface != InterfaceID))
7627                                 rr->NR_AnswerTo = NR_AnswerMulticast;
7628                         }
7629                         else if (!rr->NR_AnswerTo) rr->NR_AnswerTo = LegacyQuery ? ptr : NR_AnswerUnicast;
7630                     }
7631                 }
7632                 else if ((rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && ResourceRecordIsValidAnswer(rr))
7633                 {
7634                     // If we don't have any answers for this question, but we do own another record with the same name,
7635                     // then we'll want to mark it to generate an NSEC record on this interface
7636                     if (!NSECAnswer) NSECAnswer = rr;
7637                 }
7638             }
7639         }
7640 
7641         if (NumAnswersForThisQuestion == 0 && NSECAnswer)
7642         {
7643             NumAnswersForThisQuestion++;
7644             NSECAnswer->SendNSECNow = InterfaceID;
7645             m->NextScheduledResponse = m->timenow;
7646         }
7647 
7648         // If we couldn't answer this question, someone else might be able to,
7649         // so use random delay on response to reduce collisions
7650         if (NumAnswersForThisQuestion == 0) delayresponse = mDNSPlatformOneSecond;  // Divided by 50 = 20ms
7651 
7652         if (query->h.flags.b[0] & kDNSFlag0_TC)
7653             m->mDNSStats.KnownAnswerMultiplePkts++;
7654         // We only do the following accelerated cache expiration and duplicate question suppression processing
7655         // for non-truncated multicast queries with multicast responses.
7656         // For any query generating a unicast response we don't do this because we can't assume we will see the response.
7657         // For truncated queries we don't do this because a response we're expecting might be suppressed by a subsequent
7658         // known-answer packet, and when there's packet loss we can't safely assume we'll receive *all* known-answer packets.
7659         if (QuestionNeedsMulticastResponse && !(query->h.flags.b[0] & kDNSFlag0_TC))
7660         {
7661 #if POOF_ENABLED
7662             CacheGroup *cg = CacheGroupForName(m, pktq.qnamehash, &pktq.qname);
7663             CacheRecord *cr;
7664 
7665             // Make a list indicating which of our own cache records we expect to see updated as a result of this query
7666             // Note: Records larger than 1K are not habitually multicast, so don't expect those to be updated
7667             for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
7668                 if (SameNameRecordAnswersQuestion(&cr->resrec, &pktq) && cr->resrec.rdlength <= SmallRecordLimit)
7669                     if (!cr->NextInKAList && eap != &cr->NextInKAList)
7670                     {
7671                         *eap = cr;
7672                         eap = &cr->NextInKAList;
7673                     }
7674 #endif // POOF_ENABLED
7675 
7676             // Check if this question is the same as any of mine.
7677             // We only do this for non-truncated queries. Right now it would be too complicated to try
7678             // to keep track of duplicate suppression state between multiple packets, especially when we
7679             // can't guarantee to receive all of the Known Answer packets that go with a particular query.
7680             // For anonymous question, the duplicate suppressesion should happen if the
7681             // question belongs in the same group. As the group is expected to be
7682             // small, we don't do the optimization for now.
7683             if (!pktq.AnonInfo)
7684             {
7685                 for (q = m->Questions; q; q=q->next)
7686                     if (!q->Target.type && ActiveQuestion(q) && m->timenow - q->LastQTxTime > mDNSPlatformOneSecond / 4)
7687                         if (!q->InterfaceID || q->InterfaceID == InterfaceID)
7688                             if (q->NextInDQList == mDNSNULL && dqp != &q->NextInDQList)
7689                                 if (q->qtype == pktq.qtype &&
7690                                     q->qclass == pktq.qclass &&
7691                                     q->qnamehash == pktq.qnamehash && SameDomainName(&q->qname, &pktq.qname))
7692                                 { *dqp = q; dqp = &q->NextInDQList; }
7693             }
7694         }
7695         if (pktq.AnonInfo)
7696         {
7697             FreeAnonInfo(pktq.AnonInfo);
7698         }
7699     }
7700 
7701     // ***
7702     // *** 3. Now we can safely build the list of marked answers
7703     // ***
7704     for (rr = m->ResourceRecords; rr; rr=rr->next)              // Now build our list of potential answers
7705         if (rr->NR_AnswerTo)                                    // If we marked the record...
7706             AddRecordToResponseList(&nrp, rr, mDNSNULL);        // ... add it to the list
7707 
7708     // ***
7709     // *** 4. Add additional records
7710     // ***
7711     AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
7712 
7713     // ***
7714     // *** 5. Parse Answer Section and cancel any records disallowed by Known-Answer list
7715     // ***
7716     for (i=0; i<query->h.numAnswers; i++)                       // For each record in the query's answer section...
7717     {
7718         // Get the record...
7719         CacheRecord *ourcacherr;
7720         ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAns, &m->rec);
7721         if (!ptr) goto exit;
7722         if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
7723         {
7724             // See if this Known-Answer suppresses any of our currently planned answers
7725             for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7726             {
7727                 if (MustSendRecord(rr) && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7728                 {
7729                     m->mDNSStats.KnownAnswerSuppressions++;
7730                     rr->NR_AnswerTo = mDNSNULL;
7731                     rr->NR_AdditionalTo = mDNSNULL;
7732                 }
7733             }
7734 
7735             // See if this Known-Answer suppresses any previously scheduled answers (for multi-packet KA suppression)
7736             for (rr=m->ResourceRecords; rr; rr=rr->next)
7737             {
7738                 // If we're planning to send this answer on this interface, and only on this interface, then allow KA suppression
7739                 if (rr->ImmedAnswer == InterfaceID && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7740                 {
7741                     if (srcaddr->type == mDNSAddrType_IPv4)
7742                     {
7743                         if (mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = zerov4Addr;
7744                     }
7745                     else if (srcaddr->type == mDNSAddrType_IPv6)
7746                     {
7747                         if (mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = zerov6Addr;
7748                     }
7749                     if (mDNSIPv4AddressIsZero(rr->v4Requester) && mDNSIPv6AddressIsZero(rr->v6Requester))
7750                     {
7751                         m->mDNSStats.KnownAnswerSuppressions++;
7752                         rr->ImmedAnswer  = mDNSNULL;
7753                         rr->ImmedUnicast = mDNSfalse;
7754     #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7755                         LogMsg("Suppressed after%4d: %s", m->timenow - rr->ImmedAnswerMarkTime, ARDisplayString(m, rr));
7756     #endif
7757                     }
7758                 }
7759             }
7760 
7761             ourcacherr = FindIdenticalRecordInCache(m, &m->rec.r.resrec);
7762 
7763 #if POOF_ENABLED
7764             // Having built our ExpectedAnswers list from the questions in this packet, we then remove
7765             // any records that are suppressed by the Known Answer list in this packet.
7766             eap = &ExpectedAnswers;
7767             while (*eap)
7768             {
7769                 CacheRecord *cr = *eap;
7770                 if (cr->resrec.InterfaceID == InterfaceID && IdenticalResourceRecord(&m->rec.r.resrec, &cr->resrec))
7771                 { *eap = cr->NextInKAList; cr->NextInKAList = mDNSNULL; }
7772                 else eap = &cr->NextInKAList;
7773             }
7774 #endif // POOF_ENABLED
7775 
7776             // See if this Known-Answer is a surprise to us. If so, we shouldn't suppress our own query.
7777             if (!ourcacherr)
7778             {
7779                 dqp = &DupQuestions;
7780                 while (*dqp)
7781                 {
7782                     DNSQuestion *q = *dqp;
7783                     if (ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7784                     { *dqp = q->NextInDQList; q->NextInDQList = mDNSNULL; }
7785                     else dqp = &q->NextInDQList;
7786                 }
7787             }
7788         }
7789         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7790     }
7791 
7792     // ***
7793     // *** 6. Cancel any additionals that were added because of now-deleted records
7794     // ***
7795     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7796         if (rr->NR_AdditionalTo && !MustSendRecord(rr->NR_AdditionalTo))
7797         { rr->NR_AnswerTo = mDNSNULL; rr->NR_AdditionalTo = mDNSNULL; }
7798 
7799     // ***
7800     // *** 7. Mark the send flags on the records we plan to send
7801     // ***
7802     for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7803     {
7804         if (rr->NR_AnswerTo)
7805         {
7806             mDNSBool SendMulticastResponse = mDNSfalse;     // Send modern multicast response
7807             mDNSBool SendUnicastResponse   = mDNSfalse;     // Send modern unicast response (not legacy unicast response)
7808 
7809             // If it's been one TTL/4 since we multicast this, then send a multicast response
7810             // for conflict detection, etc.
7811             if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)TicksTTL(rr)/4)
7812             {
7813                 SendMulticastResponse = mDNStrue;
7814                 // If this record was marked for modern (delayed) unicast response, then mark it as promoted to
7815                 // multicast response instead (don't want to end up ALSO setting SendUnicastResponse in the check below).
7816                 // If this record was marked for legacy unicast response, then we mustn't change the NR_AnswerTo value.
7817                 if (rr->NR_AnswerTo == NR_AnswerUnicast)
7818                 {
7819                     m->mDNSStats.UnicastDemotedToMulticast++;
7820                     rr->NR_AnswerTo = NR_AnswerMulticast;
7821                 }
7822             }
7823 
7824             // If the client insists on a multicast response, then we'd better send one
7825             if      (rr->NR_AnswerTo == NR_AnswerMulticast)
7826             {
7827                 m->mDNSStats.MulticastResponses++;
7828                 SendMulticastResponse = mDNStrue;
7829             }
7830             else if (rr->NR_AnswerTo == NR_AnswerUnicast)
7831             {
7832                 m->mDNSStats.UnicastResponses++;
7833                 SendUnicastResponse   = mDNStrue;
7834             }
7835             else if (rr->NR_AnswerTo)
7836             {
7837                 SendLegacyResponse    = mDNStrue;
7838             }
7839 
7840             if (SendMulticastResponse || SendUnicastResponse)
7841             {
7842 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7843                 rr->ImmedAnswerMarkTime = m->timenow;
7844 #endif
7845                 m->NextScheduledResponse = m->timenow;
7846                 // If we're already planning to send this on another interface, just send it on all interfaces
7847                 if (rr->ImmedAnswer && rr->ImmedAnswer != InterfaceID)
7848                     rr->ImmedAnswer = mDNSInterfaceMark;
7849                 else
7850                 {
7851                     rr->ImmedAnswer = InterfaceID;          // Record interface to send it on
7852                     if (SendUnicastResponse) rr->ImmedUnicast = mDNStrue;
7853                     if (srcaddr->type == mDNSAddrType_IPv4)
7854                     {
7855                         if      (mDNSIPv4AddressIsZero(rr->v4Requester)) rr->v4Requester = srcaddr->ip.v4;
7856                         else if (!mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = onesIPv4Addr;
7857                     }
7858                     else if (srcaddr->type == mDNSAddrType_IPv6)
7859                     {
7860                         if      (mDNSIPv6AddressIsZero(rr->v6Requester)) rr->v6Requester = srcaddr->ip.v6;
7861                         else if (!mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = onesIPv6Addr;
7862                     }
7863                 }
7864             }
7865             // If TC flag is set, it means we should expect that additional known answers may be coming in another packet,
7866             // so we allow roughly half a second before deciding to reply (we've observed inter-packet delays of 100-200ms on 802.11)
7867             // else, if record is a shared one, spread responses over 100ms to avoid implosion of simultaneous responses
7868             // else, for a simple unique record reply, we can reply immediately; no need for delay
7869             if      (query->h.flags.b[0] & kDNSFlag0_TC) delayresponse = mDNSPlatformOneSecond * 20;            // Divided by 50 = 400ms
7870             else if (rr->resrec.RecordType == kDNSRecordTypeShared) delayresponse = mDNSPlatformOneSecond;      // Divided by 50 = 20ms
7871         }
7872         else if (rr->NR_AdditionalTo && rr->NR_AdditionalTo->NR_AnswerTo == NR_AnswerMulticast)
7873         {
7874             // Since additional records are an optimization anyway, we only ever send them on one interface at a time
7875             // If two clients on different interfaces do queries that invoke the same optional additional answer,
7876             // then the earlier client is out of luck
7877             rr->ImmedAdditional = InterfaceID;
7878             // No need to set m->NextScheduledResponse here
7879             // We'll send these additional records when we send them, or not, as the case may be
7880         }
7881     }
7882 
7883     // ***
7884     // *** 8. If we think other machines are likely to answer these questions, set our packet suppression timer
7885     // ***
7886     if (delayresponse && (!m->SuppressSending || (m->SuppressSending - m->timenow) < (delayresponse + 49) / 50))
7887     {
7888 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7889         mDNSs32 oldss = m->SuppressSending;
7890         if (oldss && delayresponse)
7891             LogMsg("Current SuppressSending delay%5ld; require%5ld", m->SuppressSending - m->timenow, (delayresponse + 49) / 50);
7892 #endif
7893         // Pick a random delay:
7894         // We start with the base delay chosen above (typically either 1 second or 20 seconds),
7895         // and add a random value in the range 0-5 seconds (making 1-6 seconds or 20-25 seconds).
7896         // This is an integer value, with resolution determined by the platform clock rate.
7897         // We then divide that by 50 to get the delay value in ticks. We defer the division until last
7898         // to get better results on platforms with coarse clock granularity (e.g. ten ticks per second).
7899         // The +49 before dividing is to ensure we round up, not down, to ensure that even
7900         // on platforms where the native clock rate is less than fifty ticks per second,
7901         // we still guarantee that the final calculated delay is at least one platform tick.
7902         // We want to make sure we don't ever allow the delay to be zero ticks,
7903         // because if that happens we'll fail the Bonjour Conformance Test.
7904         // Our final computed delay is 20-120ms for normal delayed replies,
7905         // or 400-500ms in the case of multi-packet known-answer lists.
7906         m->SuppressSending = m->timenow + (delayresponse + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*5) + 49) / 50;
7907         if (m->SuppressSending == 0) m->SuppressSending = 1;
7908 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7909         if (oldss && delayresponse)
7910             LogMsg("Set     SuppressSending to   %5ld", m->SuppressSending - m->timenow);
7911 #endif
7912     }
7913 
7914     // ***
7915     // *** 9. If query is from a legacy client, or from a new client requesting a unicast reply, then generate a unicast response too
7916     // ***
7917     if (SendLegacyResponse)
7918         responseptr = GenerateUnicastResponse(query, end, InterfaceID, LegacyQuery, response, ResponseRecords);
7919 
7920 exit:
7921     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
7922 
7923     // ***
7924     // *** 10. Finally, clear our link chains ready for use next time
7925     // ***
7926     while (ResponseRecords)
7927     {
7928         rr = ResponseRecords;
7929         ResponseRecords = rr->NextResponse;
7930         rr->NextResponse    = mDNSNULL;
7931         rr->NR_AnswerTo     = mDNSNULL;
7932         rr->NR_AdditionalTo = mDNSNULL;
7933     }
7934 
7935 #if POOF_ENABLED
7936     while (ExpectedAnswers)
7937     {
7938         CacheRecord *cr = ExpectedAnswers;
7939         ExpectedAnswers = cr->NextInKAList;
7940         cr->NextInKAList = mDNSNULL;
7941 
7942         // For non-truncated queries, we can definitively say that we should expect
7943         // to be seeing a response for any records still left in the ExpectedAnswers list
7944         if (!(query->h.flags.b[0] & kDNSFlag0_TC))
7945             if (cr->UnansweredQueries == 0 || m->timenow - cr->LastUnansweredTime >= mDNSPlatformOneSecond * 3/4)
7946             {
7947                 cr->UnansweredQueries++;
7948                 cr->LastUnansweredTime = m->timenow;
7949                 if (cr->UnansweredQueries > 1)
7950                         debugf("ProcessQuery: UnansweredQueries %lu %s", cr->UnansweredQueries, CRDisplayString(m, cr));
7951                 SetNextCacheCheckTimeForRecord(m, cr);
7952             }
7953 
7954         // If we've seen multiple unanswered queries for this record,
7955         // then mark it to expire in five seconds if we don't get a response by then.
7956         if (cr->UnansweredQueries >= MaxUnansweredQueries)
7957         {
7958             // Only show debugging message if this record was not about to expire anyway
7959             if (RRExpireTime(cr) - m->timenow > (mDNSs32) kDefaultReconfirmTimeForNoAnswer * 4 / 3 + mDNSPlatformOneSecond)
7960                     LogInfo("ProcessQuery: UnansweredQueries %lu interface %lu TTL %lu mDNS_Reconfirm() for %s",
7961                        cr->UnansweredQueries, InterfaceID, (RRExpireTime(cr) - m->timenow + mDNSPlatformOneSecond-1) / mDNSPlatformOneSecond, CRDisplayString(m, cr));
7962 
7963             m->mDNSStats.PoofCacheDeletions++;
7964             mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
7965         }
7966     }
7967 #endif // POOF_ENABLED
7968 
7969     while (DupQuestions)
7970     {
7971         DNSQuestion *q = DupQuestions;
7972         DupQuestions = q->NextInDQList;
7973         q->NextInDQList = mDNSNULL;
7974         RecordDupSuppressInfo(q->DupSuppress, m->timenow, InterfaceID, srcaddr->type);
7975         debugf("ProcessQuery: Recorded DSI for %##s (%s) on %p/%s", q->qname.c, DNSTypeName(q->qtype), InterfaceID,
7976                srcaddr->type == mDNSAddrType_IPv4 ? "v4" : "v6");
7977     }
7978 
7979     if (McastNSEC3Records)
7980     {
7981         debugf("ProcessQuery: McastNSEC3Records not used");
7982         FreeNSECRecords(m, McastNSEC3Records);
7983     }
7984 
7985     return(responseptr);
7986 }
7987 
7988 mDNSlocal void mDNSCoreReceiveQuery(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
7989                                     const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
7990                                     const mDNSInterfaceID InterfaceID)
7991 {
7992     mDNSu8    *responseend = mDNSNULL;
7993     mDNSBool QueryWasLocalUnicast = srcaddr && dstaddr &&
7994                                     !mDNSAddrIsDNSMulticast(dstaddr) && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
7995 
7996     if (!dstaddr || (!InterfaceID && mDNSAddrIsDNSMulticast(dstaddr)))
7997     {
7998         const char *const reason = !dstaddr ? "Received over TCP connection" : "Multicast, but no InterfaceID";
7999         LogMsg("Ignoring Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8000                "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes (%s)",
8001                srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8002                msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
8003                msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
8004                msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
8005                msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data, reason);
8006         return;
8007     }
8008 
8009     verbosedebugf("Received Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8010                   "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
8011                   srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8012                   msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
8013                   msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
8014                   msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
8015                   msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data);
8016 
8017     responseend = ProcessQuery(m, msg, end, srcaddr, InterfaceID,
8018                                !mDNSSameIPPort(srcport, MulticastDNSPort), mDNSAddrIsDNSMulticast(dstaddr), QueryWasLocalUnicast, &m->omsg);
8019 
8020     if (responseend)    // If responseend is non-null, that means we built a unicast response packet
8021     {
8022         debugf("Unicast Response: %d Question%s, %d Answer%s, %d Additional%s to %#-15a:%d on %p/%ld",
8023                m->omsg.h.numQuestions,   m->omsg.h.numQuestions   == 1 ? "" : "s",
8024                m->omsg.h.numAnswers,     m->omsg.h.numAnswers     == 1 ? "" : "s",
8025                m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s",
8026                srcaddr, mDNSVal16(srcport), InterfaceID, srcaddr->type);
8027         mDNSSendDNSMessage(m, &m->omsg, responseend, InterfaceID, mDNSNULL, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
8028     }
8029 }
8030 
8031 #if 0
8032 mDNSlocal mDNSBool TrustedSource(const mDNS *const m, const mDNSAddr *const srcaddr)
8033 {
8034     DNSServer *s;
8035     (void)m; // Unused
8036     (void)srcaddr; // Unused
8037     for (s = m->DNSServers; s; s = s->next)
8038         if (mDNSSameAddress(srcaddr, &s->addr)) return(mDNStrue);
8039     return(mDNSfalse);
8040 }
8041 #endif
8042 
8043 struct UDPSocket_struct
8044 {
8045     mDNSIPPort port; // MUST BE FIRST FIELD -- mDNSCoreReceive expects every UDPSocket_struct to begin with mDNSIPPort port
8046 };
8047 
8048 mDNSlocal DNSQuestion *ExpectingUnicastResponseForQuestion(const mDNS *const m, const mDNSIPPort port, const mDNSOpaque16 id, const DNSQuestion *const question, mDNSBool tcp)
8049 {
8050     DNSQuestion *q;
8051     for (q = m->Questions; q; q=q->next)
8052     {
8053         if (!tcp && !q->LocalSocket) continue;
8054         if (mDNSSameIPPort(tcp ? q->tcpSrcPort : q->LocalSocket->port, port)     &&
8055             mDNSSameOpaque16(q->TargetQID,         id)       &&
8056             q->qtype                  == question->qtype     &&
8057             q->qclass                 == question->qclass    &&
8058             q->qnamehash              == question->qnamehash &&
8059             SameDomainName(&q->qname, &question->qname))
8060             return(q);
8061     }
8062     return(mDNSNULL);
8063 }
8064 
8065 // This function is called when we receive a unicast response. This could be the case of a unicast response from the
8066 // DNS server or a response to the QU query. Hence, the cache record's InterfaceId can be both NULL or non-NULL (QU case)
8067 mDNSlocal DNSQuestion *ExpectingUnicastResponseForRecord(mDNS *const m,
8068                                                          const mDNSAddr *const srcaddr, const mDNSBool SrcLocal, const mDNSIPPort port, const mDNSOpaque16 id, const CacheRecord *const rr, mDNSBool tcp)
8069 {
8070     DNSQuestion *q;
8071     (void)id;
8072     (void)srcaddr;
8073 
8074     for (q = m->Questions; q; q=q->next)
8075     {
8076         if (!q->DuplicateOf && ResourceRecordAnswersUnicastResponse(&rr->resrec, q))
8077         {
8078             if (!mDNSOpaque16IsZero(q->TargetQID))
8079             {
8080                 debugf("ExpectingUnicastResponseForRecord msg->h.id %d q->TargetQID %d for %s", mDNSVal16(id), mDNSVal16(q->TargetQID), CRDisplayString(m, rr));
8081 
8082                 if (mDNSSameOpaque16(q->TargetQID, id))
8083                 {
8084                     mDNSIPPort srcp;
8085                     if (!tcp)
8086                     {
8087                         srcp = q->LocalSocket ? q->LocalSocket->port : zeroIPPort;
8088                     }
8089                     else
8090                     {
8091                         srcp = q->tcpSrcPort;
8092                     }
8093                     if (mDNSSameIPPort(srcp, port)) return(q);
8094 
8095                     //  if (mDNSSameAddress(srcaddr, &q->Target))                   return(mDNStrue);
8096                     //  if (q->LongLived && mDNSSameAddress(srcaddr, &q->servAddr)) return(mDNStrue); Shouldn't need this now that we have LLQType checking
8097                     //  if (TrustedSource(m, srcaddr))                              return(mDNStrue);
8098                     LogInfo("WARNING: Ignoring suspect uDNS response for %##s (%s) [q->Target %#a:%d] from %#a:%d %s",
8099                             q->qname.c, DNSTypeName(q->qtype), &q->Target, mDNSVal16(srcp), srcaddr, mDNSVal16(port), CRDisplayString(m, rr));
8100                     return(mDNSNULL);
8101                 }
8102             }
8103             else
8104             {
8105                 if (SrcLocal && q->ExpectUnicastResp && (mDNSu32)(m->timenow - q->ExpectUnicastResp) < (mDNSu32)(mDNSPlatformOneSecond*2))
8106                     return(q);
8107             }
8108         }
8109     }
8110     return(mDNSNULL);
8111 }
8112 
8113 // Certain data types need more space for in-memory storage than their in-packet rdlength would imply
8114 // Currently this applies only to rdata types containing more than one domainname,
8115 // or types where the domainname is not the last item in the structure.
8116 mDNSlocal mDNSu16 GetRDLengthMem(const ResourceRecord *const rr)
8117 {
8118     switch (rr->rrtype)
8119     {
8120     case kDNSType_SOA: return sizeof(rdataSOA);
8121     case kDNSType_RP:  return sizeof(rdataRP);
8122     case kDNSType_PX:  return sizeof(rdataPX);
8123     default:           return rr->rdlength;
8124     }
8125 }
8126 
8127 mDNSexport CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg, mDNSs32 delay, mDNSBool Add, const mDNSAddr *sourceAddress)
8128 {
8129     CacheRecord *rr = mDNSNULL;
8130     mDNSu16 RDLength = GetRDLengthMem(&m->rec.r.resrec);
8131 
8132     if (!m->rec.r.resrec.InterfaceID) debugf("CreateNewCacheEntry %s", CRDisplayString(m, &m->rec.r));
8133 
8134     //if (RDLength > InlineCacheRDSize)
8135     //  LogInfo("Rdata len %4d > InlineCacheRDSize %d %s", RDLength, InlineCacheRDSize, CRDisplayString(m, &m->rec.r));
8136 
8137     if (!cg) cg = GetCacheGroup(m, slot, &m->rec.r.resrec); // If we don't have a CacheGroup for this name, make one now
8138     if (cg) rr = GetCacheRecord(m, cg, RDLength);   // Make a cache record, being careful not to recycle cg
8139     if (!rr) NoCacheAnswer(m, &m->rec.r);
8140     else
8141     {
8142         RData *saveptr = rr->resrec.rdata;      // Save the rr->resrec.rdata pointer
8143         *rr = m->rec.r;                         // Block copy the CacheRecord object
8144         rr->resrec.rdata  = saveptr;            // Restore rr->resrec.rdata after the structure assignment
8145         rr->resrec.name   = cg->name;           // And set rr->resrec.name to point into our CacheGroup header
8146 
8147         // We need to add the anonymous info before we call CacheRecordAdd so that
8148         // if it finds a matching question with this record, it bumps up the counters like
8149         // CurrentAnswers etc. Otherwise, when a cache entry gets removed, CacheRecordRmv
8150         // will complain.
8151         if (m->rec.r.resrec.AnonInfo)
8152         {
8153             rr->resrec.AnonInfo = m->rec.r.resrec.AnonInfo;
8154             m->rec.r.resrec.AnonInfo = mDNSNULL;
8155         }
8156         rr->DelayDelivery = delay;
8157 
8158         // If this is an oversized record with external storage allocated, copy rdata to external storage
8159         if      (rr->resrec.rdata == (RData*)&rr->smallrdatastorage && RDLength > InlineCacheRDSize)
8160             LogMsg("rr->resrec.rdata == &rr->rdatastorage but length > InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8161         else if (rr->resrec.rdata != (RData*)&rr->smallrdatastorage && RDLength <= InlineCacheRDSize)
8162             LogMsg("rr->resrec.rdata != &rr->rdatastorage but length <= InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8163         if (RDLength > InlineCacheRDSize)
8164             mDNSPlatformMemCopy(rr->resrec.rdata, m->rec.r.resrec.rdata, sizeofRDataHeader + RDLength);
8165 
8166         rr->next = mDNSNULL;                    // Clear 'next' pointer
8167         rr->nsec = mDNSNULL;
8168         rr->soa  = mDNSNULL;
8169 
8170         if (sourceAddress)
8171             rr->sourceAddress = *sourceAddress;
8172 
8173         if (!rr->resrec.InterfaceID)
8174         {
8175             m->rrcache_totalused_unicast += rr->resrec.rdlength;
8176             if (DNSSECRecordType(rr->resrec.rrtype))
8177                 BumpDNSSECStats(m, kStatsActionIncrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
8178         }
8179 
8180         if (Add)
8181         {
8182             *(cg->rrcache_tail) = rr;               // Append this record to tail of cache slot list
8183             cg->rrcache_tail = &(rr->next);         // Advance tail pointer
8184             CacheRecordAdd(m, rr);  // CacheRecordAdd calls SetNextCacheCheckTimeForRecord(m, rr); for us
8185         }
8186         else
8187         {
8188             // Can't use the "cg->name" if we are not adding to the cache as the
8189             // CacheGroup may be released anytime if it is empty
8190             domainname *name = mDNSPlatformMemAllocate(DomainNameLength(cg->name));
8191             if (name)
8192             {
8193                 AssignDomainName(name, cg->name);
8194                 rr->resrec.name   = name;
8195             }
8196             else
8197             {
8198                 ReleaseCacheRecord(m, rr);
8199                 NoCacheAnswer(m, &m->rec.r);
8200                 rr = mDNSNULL;
8201             }
8202         }
8203     }
8204     return(rr);
8205 }
8206 
8207 mDNSlocal void RefreshCacheRecord(mDNS *const m, CacheRecord *rr, mDNSu32 ttl)
8208 {
8209     rr->TimeRcvd             = m->timenow;
8210     rr->resrec.rroriginalttl = ttl;
8211     rr->UnansweredQueries = 0;
8212     SetNextCacheCheckTimeForRecord(m, rr);
8213 }
8214 
8215 mDNSexport void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease)
8216 {
8217     CacheRecord *rr;
8218     CacheGroup *cg = CacheGroupForName(m, q->qnamehash, &q->qname);
8219     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8220         if (rr->CRActiveQuestion == q)
8221         {
8222             //LogInfo("GrantCacheExtensions: new lease %d / %s", lease, CRDisplayString(m, rr));
8223             RefreshCacheRecord(m, rr, lease);
8224         }
8225 }
8226 
8227 mDNSlocal mDNSu32 GetEffectiveTTL(const uDNS_LLQType LLQType, mDNSu32 ttl)      // TTL in seconds
8228 {
8229     if      (LLQType == uDNS_LLQ_Entire) ttl = kLLQ_DefLease;
8230     else if (LLQType == uDNS_LLQ_Events)
8231     {
8232         // If the TTL is -1 for uDNS LLQ event packet, that means "remove"
8233         if (ttl == 0xFFFFFFFF) ttl = 0;
8234         else ttl = kLLQ_DefLease;
8235     }
8236     else    // else not LLQ (standard uDNS response)
8237     {
8238         // The TTL is already capped to a maximum value in GetLargeResourceRecord, but just to be extra safe we
8239         // also do this check here to make sure we can't get overflow below when we add a quarter to the TTL
8240         if (ttl > 0x60000000UL / mDNSPlatformOneSecond) ttl = 0x60000000UL / mDNSPlatformOneSecond;
8241 
8242         ttl = RRAdjustTTL(ttl);
8243 
8244         // For mDNS, TTL zero means "delete this record"
8245         // For uDNS, TTL zero means: this data is true at this moment, but don't cache it.
8246         // For the sake of network efficiency, we impose a minimum effective TTL of 15 seconds.
8247         // This means that we'll do our 80, 85, 90, 95% queries at 12.00, 12.75, 13.50, 14.25 seconds
8248         // respectively, and then if we get no response, delete the record from the cache at 15 seconds.
8249         // This gives the server up to three seconds to respond between when we send our 80% query at 12 seconds
8250         // and when we delete the record at 15 seconds. Allowing cache lifetimes less than 15 seconds would
8251         // (with the current code) result in the server having even less than three seconds to respond
8252         // before we deleted the record and reported a "remove" event to any active questions.
8253         // Furthermore, with the current code, if we were to allow a TTL of less than 2 seconds
8254         // then things really break (e.g. we end up making a negative cache entry).
8255         // In the future we may want to revisit this and consider properly supporting non-cached (TTL=0) uDNS answers.
8256         if (ttl < 15) ttl = 15;
8257     }
8258 
8259     return ttl;
8260 }
8261 
8262 // When the response does not match the question directly, we still want to cache them sometimes. The current response is
8263 // in m->rec.
8264 mDNSlocal mDNSBool IsResponseAcceptable(mDNS *const m, const CacheRecord *crlist, DNSQuestion *q, mDNSBool *nseclist)
8265 {
8266     CacheRecord *const newcr = &m->rec.r;
8267     ResourceRecord *rr = &newcr->resrec;
8268     const CacheRecord *cr;
8269 
8270     *nseclist = mDNSfalse;
8271     for (cr = crlist; cr != (CacheRecord*)1; cr = cr->NextInCFList)
8272     {
8273         domainname *target = GetRRDomainNameTarget(&cr->resrec);
8274         // When we issue a query for A record, the response might contain both a CNAME and A records. Only the CNAME would
8275         // match the question and we already created a cache entry in the previous pass of this loop. Now when we process
8276         // the A record, it does not match the question because the record name here is the CNAME. Hence we try to
8277         // match with the previous records to make it an AcceptableResponse. We have to be careful about setting the
8278         // DNSServer value that we got in the previous pass. This can happen for other record types like SRV also.
8279 
8280         if (target && cr->resrec.rdatahash == rr->namehash && SameDomainName(target, rr->name))
8281         {
8282             LogInfo("IsResponseAcceptable: Found a matching entry for %##s in the CacheFlushRecords %s", rr->name->c, CRDisplayString(m, cr));
8283             return (mDNStrue);
8284         }
8285     }
8286 
8287     // Either the question requires validation or we are validating a response with DNSSEC in which case
8288     // we need to accept the RRSIGs also so that we can validate the response. It is also possible that
8289     // we receive NSECs for our query which does not match the qname and we need to cache in that case
8290     // too. nseclist is set if they have to be cached as part of the negative cache record.
8291     if (q && DNSSECQuestion(q))
8292     {
8293         mDNSBool same = SameDomainName(&q->qname, rr->name);
8294         if (same && (q->qtype == rr->rrtype || rr->rrtype == kDNSType_CNAME))
8295         {
8296             LogInfo("IsResponseAcceptable: Accepting, same name and qtype %s, CR %s", DNSTypeName(q->qtype),
8297                     CRDisplayString(m, newcr));
8298             return mDNStrue;
8299         }
8300         // We cache RRSIGS if it covers the question type or NSEC.  If it covers a NSEC,
8301         // "nseclist" is set
8302         if (rr->rrtype == kDNSType_RRSIG)
8303         {
8304             RDataBody2 *const rdb = (RDataBody2 *)newcr->smallrdatastorage.data;
8305             rdataRRSig *rrsig = &rdb->rrsig;
8306             mDNSu16 typeCovered = swap16(rrsig->typeCovered);
8307 
8308             // Note the ordering. If we are looking up the NSEC record, then the RRSIG's typeCovered
8309             // would match the qtype and they are cached normally as they are not used to prove the
8310             // non-existence of any name. In that case, it is like any other normal dnssec validation
8311             // and hence nseclist should not be set.
8312 
8313             if (same && ((typeCovered == q->qtype) || (typeCovered == kDNSType_CNAME)))
8314             {
8315                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches question type %s", CRDisplayString(m, newcr),
8316                         DNSTypeName(q->qtype));
8317                 return mDNStrue;
8318             }
8319             else if (typeCovered == kDNSType_NSEC || typeCovered == kDNSType_NSEC3)
8320             {
8321                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches %s type (nseclist = 1)", CRDisplayString(m, newcr), DNSTypeName(typeCovered));
8322                 *nseclist = mDNStrue;
8323                 return mDNStrue;
8324             }
8325             else if (typeCovered == kDNSType_SOA)
8326             {
8327                 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches SOA type (nseclist = 1)", CRDisplayString(m, newcr));
8328                 *nseclist = mDNStrue;
8329                 return mDNStrue;
8330             }
8331             else return mDNSfalse;
8332         }
8333         if (rr->rrtype == kDNSType_NSEC)
8334         {
8335             if (!UNICAST_NSEC(rr))
8336             {
8337                 LogMsg("IsResponseAcceptable: ERROR!! Not a unicast NSEC %s", CRDisplayString(m, newcr));
8338                 return mDNSfalse;
8339             }
8340             LogInfo("IsResponseAcceptable: Accepting NSEC %s (nseclist = 1)", CRDisplayString(m, newcr));
8341             *nseclist = mDNStrue;
8342             return mDNStrue;
8343         }
8344         if (rr->rrtype == kDNSType_SOA)
8345         {
8346             LogInfo("IsResponseAcceptable: Accepting SOA %s (nseclist = 1)", CRDisplayString(m, newcr));
8347             *nseclist = mDNStrue;
8348             return mDNStrue;
8349         }
8350         else if (rr->rrtype == kDNSType_NSEC3)
8351         {
8352             LogInfo("IsResponseAcceptable: Accepting NSEC3 %s (nseclist = 1)", CRDisplayString(m, newcr));
8353             *nseclist = mDNStrue;
8354             return mDNStrue;
8355         }
8356     }
8357     return mDNSfalse;
8358 }
8359 
8360 mDNSlocal void FreeNSECRecords(mDNS *const m, CacheRecord *NSECRecords)
8361 {
8362     CacheRecord *rp, *next;
8363 
8364     for (rp = NSECRecords; rp; rp = next)
8365     {
8366         next = rp->next;
8367         ReleaseCacheRecord(m, rp);
8368     }
8369 }
8370 
8371 // If we received zero DNSSEC records even when the DO/EDNS0 bit was set, we need to provide this
8372 // information to ValidatingResponse question to indicate the DNSSEC status to the application
8373 mDNSlocal void mDNSCoreReceiveNoDNSSECAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8374     mDNSIPPort dstport, const mDNSInterfaceID InterfaceID)
8375 {
8376     int i;
8377     const mDNSu8 *ptr = response->data;
8378 
8379     for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8380     {
8381         DNSQuestion pktq;
8382         DNSQuestion *qptr = mDNSNULL;
8383         ptr = getQuestion(response, ptr, end, InterfaceID, &pktq);
8384         if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &pktq, !dstaddr)) &&
8385             qptr->ValidatingResponse)
8386         {
8387             DNSQuestion *next, *q;
8388 
8389             if (qptr->DuplicateOf)
8390                 LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question matching response", qptr->qname.c, DNSTypeName(qptr->qtype));
8391 
8392             // Be careful to call the callback for duplicate questions first and then the original
8393             // question. If we called the callback on the original question, it could stop and
8394             // a duplicate question would become the original question.
8395             mDNS_DropLockBeforeCallback();      // Allow client (and us) to legally make mDNS API calls
8396             for (q = qptr->next ; q && q != m->NewQuestions; q = next)
8397             {
8398                 next = q->next;
8399                 if (q->DuplicateOf == qptr)
8400                 {
8401                     if (q->ValidatingResponse)
8402                         LogInfo("mDNSCoreReceiveNoDNSSECAnswers: qptr %##s (%s) Duplicate question found", q->qname.c, DNSTypeName(q->qtype));
8403                     else
8404                         LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question not ValidatingResponse", q->qname.c, DNSTypeName(q->qtype));
8405                     if (q->QuestionCallback)
8406                         q->QuestionCallback(m, q, mDNSNULL, QC_nodnssec);
8407                 }
8408             }
8409             if (qptr->QuestionCallback)
8410                 qptr->QuestionCallback(m, qptr, mDNSNULL, QC_nodnssec);
8411             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
8412         }
8413     }
8414 }
8415 
8416 mDNSlocal void mDNSCoreReceiveNoUnicastAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8417                                                mDNSIPPort dstport, const mDNSInterfaceID InterfaceID, uDNS_LLQType LLQType, mDNSu8 rcode, CacheRecord *NSECRecords)
8418 {
8419     int i;
8420     const mDNSu8 *ptr   = response->data;
8421     CacheRecord *SOARecord = mDNSNULL;
8422 
8423     for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8424     {
8425         DNSQuestion q;
8426         DNSQuestion *qptr = mDNSNULL;
8427         ptr = getQuestion(response, ptr, end, InterfaceID, &q);
8428         if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr)))
8429         {
8430             CacheRecord *rr, *neg = mDNSNULL;
8431             CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
8432             for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8433                 if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
8434                 {
8435                     // 1. If we got a fresh answer to this query, then don't need to generate a negative entry
8436                     if (RRExpireTime(rr) - m->timenow > 0) break;
8437                     // 2. If we already had a negative entry, keep track of it so we can resurrect it instead of creating a new one
8438                     if (rr->resrec.RecordType == kDNSRecordTypePacketNegative) neg = rr;
8439                 }
8440             // When we're doing parallel unicast and multicast queries for dot-local names (for supporting Microsoft
8441             // Active Directory sites) we don't want to waste memory making negative cache entries for all the unicast answers.
8442             // Otherwise we just fill up our cache with negative entries for just about every single multicast name we ever look up
8443             // (since the Microsoft Active Directory server is going to assert that pretty much every single multicast name doesn't exist).
8444             // This is not only a waste of memory, but there's also the problem of those negative entries confusing us later -- e.g. we
8445             // suppress sending our mDNS query packet because we think we already have a valid (negative) answer to that query in our cache.
8446             // The one exception is that we *DO* want to make a negative cache entry for "local. SOA", for the (common) case where we're
8447             // *not* on a Microsoft Active Directory network, and there is no authoritative server for "local". Note that this is not
8448             // in conflict with the mDNS spec, because that spec says, "Multicast DNS Zones have no SOA record," so it's okay to cache
8449             // negative answers for "local. SOA" from a uDNS server, because the mDNS spec already says that such records do not exist :-)
8450             //
8451             // By suppressing negative responses, it might take longer to timeout a .local question as it might be expecting a
8452             // response e.g., we deliver a positive "A" response and suppress negative "AAAA" response and the upper layer may
8453             // be waiting longer to get the AAAA response before returning the "A" response to the application. To handle this
8454             // case without creating the negative cache entries, we generate a negative response and let the layer above us
8455             // do the appropriate thing. This negative response is also needed for appending new search domains.
8456             if (!InterfaceID && q.qtype != kDNSType_SOA && IsLocalDomain(&q.qname))
8457             {
8458                 if (!rr)
8459                 {
8460                     LogInfo("mDNSCoreReceiveNoUnicastAnswers: Generate negative response for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8461                     m->CurrentQuestion = qptr;
8462                     // We are not creating a cache record in this case, we need to pass back
8463                     // the error we got so that the proxy code can return the right one to
8464                     // the application
8465                     if (qptr->ProxyQuestion)
8466                         qptr->responseFlags = response->h.flags;
8467                     GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
8468                     m->CurrentQuestion = mDNSNULL;
8469                 }
8470                 else
8471                 {
8472                     LogInfo("mDNSCoreReceiveNoUnicastAnswers: Skipping check and not creating a negative cache entry for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8473                 }
8474             }
8475             else
8476             {
8477                 if (!rr)
8478                 {
8479                     // We start off assuming a negative caching TTL of 60 seconds
8480                     // but then look to see if we can find an SOA authority record to tell us a better value we should be using
8481                     mDNSu32 negttl = 60;
8482                     int repeat = 0;
8483                     const domainname *name = &q.qname;
8484                     mDNSu32 hash = q.qnamehash;
8485 
8486                     // Special case for our special Microsoft Active Directory "local SOA" check.
8487                     // Some cheap home gateways don't include an SOA record in the authority section when
8488                     // they send negative responses, so we don't know how long to cache the negative result.
8489                     // Because we don't want to keep hitting the root name servers with our query to find
8490                     // if we're on a network using Microsoft Active Directory using "local" as a private
8491                     // internal top-level domain, we make sure to cache the negative result for at least one day.
8492                     if (q.qtype == kDNSType_SOA && SameDomainName(&q.qname, &localdomain)) negttl = 60 * 60 * 24;
8493 
8494                     // If we're going to make (or update) a negative entry, then look for the appropriate TTL from the SOA record
8495                     if (response->h.numAuthorities && (ptr = LocateAuthorities(response, end)) != mDNSNULL)
8496                     {
8497                         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8498                         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_SOA)
8499                         {
8500                             CacheGroup *cgSOA = CacheGroupForRecord(m, &m->rec.r.resrec);
8501                             const rdataSOA *const soa = (const rdataSOA *)m->rec.r.resrec.rdata->u.data;
8502                             mDNSu32 ttl_s = soa->min;
8503                             // We use the lesser of the SOA.MIN field and the SOA record's TTL, *except*
8504                             // for the SOA record for ".", where the record is reported as non-cacheable
8505                             // (TTL zero) for some reason, so in this case we just take the SOA record's TTL as-is
8506                             if (ttl_s > m->rec.r.resrec.rroriginalttl && m->rec.r.resrec.name->c[0])
8507                                 ttl_s = m->rec.r.resrec.rroriginalttl;
8508                             if (negttl < ttl_s) negttl = ttl_s;
8509 
8510                             // Create the SOA record as we may have to return this to the questions
8511                             // that we are acting as a proxy for currently or in the future.
8512                             SOARecord = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cgSOA, 1, mDNSfalse, mDNSNULL);
8513 
8514                             // Special check for SOA queries: If we queried for a.b.c.d.com, and got no answer,
8515                             // with an Authority Section SOA record for d.com, then this is a hint that the authority
8516                             // is d.com, and consequently SOA records b.c.d.com and c.d.com don't exist either.
8517                             // To do this we set the repeat count so the while loop below will make a series of negative cache entries for us
8518                             //
8519                             // For ProxyQuestions, we don't do this as we need to create additional SOA records to cache them
8520                             // along with the negative cache record. For simplicity, we don't create the additional records.
8521                             if (!qptr->ProxyQuestion && q.qtype == kDNSType_SOA)
8522                             {
8523                                 int qcount = CountLabels(&q.qname);
8524                                 int scount = CountLabels(m->rec.r.resrec.name);
8525                                 if (qcount - 1 > scount)
8526                                     if (SameDomainName(SkipLeadingLabels(&q.qname, qcount - scount), m->rec.r.resrec.name))
8527                                         repeat = qcount - 1 - scount;
8528                             }
8529                         }
8530                         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8531                     }
8532 
8533                     // If we already had a negative entry in the cache, then we double our existing negative TTL. This is to avoid
8534                     // the case where the record doesn't exist (e.g. particularly for things like our lb._dns-sd._udp.<domain> query),
8535                     // and the server returns no SOA record (or an SOA record with a small MIN TTL) so we assume a TTL
8536                     // of 60 seconds, and we end up polling the server every minute for a record that doesn't exist.
8537                     // With this fix in place, when this happens, we double the effective TTL each time (up to one hour),
8538                     // so that we back off our polling rate and don't keep hitting the server continually.
8539                     if (neg)
8540                     {
8541                         if (negttl < neg->resrec.rroriginalttl * 2)
8542                             negttl = neg->resrec.rroriginalttl * 2;
8543                         if (negttl > 3600)
8544                             negttl = 3600;
8545                     }
8546 
8547                     negttl = GetEffectiveTTL(LLQType, negttl);  // Add 25% grace period if necessary
8548 
8549                     // If we already had a negative cache entry just update it, else make one or more new negative cache entries.
8550                     if (neg)
8551                     {
8552                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: Renewing negative TTL from %d to %d %s", neg->resrec.rroriginalttl, negttl, CRDisplayString(m, neg));
8553                         RefreshCacheRecord(m, neg, negttl);
8554                         // When we created the cache for the first time and answered the question, the question's
8555                         // interval was set to MaxQuestionInterval. If the cache is about to expire and we are resending
8556                         // the queries, the interval should still be at MaxQuestionInterval. If the query is being
8557                         // restarted (setting it to InitialQuestionInterval) for other reasons e.g., wakeup,
8558                         // we should reset its question interval here to MaxQuestionInterval.
8559                         ResetQuestionState(m, qptr);
8560                         if (DNSSECQuestion(qptr))
8561                             neg->CRDNSSECQuestion = 1;
8562                         // Update the NSEC records again.
8563                         // TBD: Need to purge and revalidate if the cached NSECS and the new set are not same.
8564                         if (NSECRecords)
8565                         {
8566                             if (!AddNSECSForCacheRecord(m, NSECRecords, neg, rcode))
8567                             {
8568                                 // We might just have an SOA record for zones that are not signed and hence don't log
8569                                 // this as an error
8570                                 LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s during refresh", CRDisplayString(m, neg));
8571                                 FreeNSECRecords(m, NSECRecords);
8572                                 neg->CRDNSSECQuestion = 0;
8573                             }
8574                             NSECRecords = mDNSNULL;
8575                         }
8576                         if (SOARecord)
8577                         {
8578                             if (neg->soa)
8579                                 ReleaseCacheRecord(m, neg->soa);
8580                             neg->soa = SOARecord;
8581                             SOARecord = mDNSNULL;
8582                         }
8583                     }
8584                     else while (1)
8585                         {
8586                             CacheRecord *negcr;
8587                             debugf("mDNSCoreReceiveNoUnicastAnswers making negative cache entry TTL %d for %##s (%s)", negttl, name->c, DNSTypeName(q.qtype));
8588                             MakeNegativeCacheRecord(m, &m->rec.r, name, hash, q.qtype, q.qclass, negttl, mDNSInterface_Any, qptr->qDNSServer);
8589                             m->rec.r.responseFlags = response->h.flags;
8590                             // We create SOA records above which might create new cache groups. Earlier
8591                             // in the function we looked up the cache group for the name and it could have
8592                             // been NULL. If we pass NULL cg to new cache entries that we create below,
8593                             // it will create additional cache groups for the same name. To avoid that,
8594                             // look up the cache group again to re-initialize cg again.
8595                             cg = CacheGroupForName(m, hash, name);
8596                             if (NSECRecords && DNSSECQuestion(qptr))
8597                             {
8598                                 // Create the cache entry with delay and then add the NSEC records
8599                                 // to it and add it immediately.
8600                                 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8601                                 if (negcr)
8602                                 {
8603                                     negcr->CRDNSSECQuestion = 0;
8604                                     if (!AddNSECSForCacheRecord(m, NSECRecords, negcr, rcode))
8605                                     {
8606                                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s",
8607                                             CRDisplayString(m, negcr));
8608                                         FreeNSECRecords(m, NSECRecords);
8609                                     }
8610                                     else
8611                                     {
8612                                         negcr->CRDNSSECQuestion = 1;
8613                                         LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord added neg NSEC for %s", CRDisplayString(m, negcr));
8614                                     }
8615                                     NSECRecords = mDNSNULL;
8616                                     negcr->DelayDelivery = 0;
8617                                     CacheRecordDeferredAdd(m, negcr);
8618                                 }
8619                                 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8620                                 break;
8621                             }
8622                             else
8623                             {
8624                                 // Need to add with a delay so that we can tag the SOA record
8625                                 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8626                                 if (negcr)
8627                                 {
8628                                     negcr->CRDNSSECQuestion = 0;
8629                                     if (DNSSECQuestion(qptr))
8630                                         negcr->CRDNSSECQuestion = 1;
8631                                     negcr->DelayDelivery = 0;
8632 
8633                                     if (SOARecord)
8634                                     {
8635                                         if (negcr->soa)
8636                                             ReleaseCacheRecord(m, negcr->soa);
8637                                         negcr->soa = SOARecord;
8638                                         SOARecord = mDNSNULL;
8639                                     }
8640                                     CacheRecordDeferredAdd(m, negcr);
8641                                 }
8642                             }
8643                             m->rec.r.responseFlags = zeroID;
8644                             m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8645                             if (!repeat) break;
8646                             repeat--;
8647                             name = (const domainname *)(name->c + 1 + name->c[0]);
8648                             hash = DomainNameHashValue(name);
8649                         }
8650                 }
8651             }
8652         }
8653     }
8654     if (NSECRecords) { LogInfo("mDNSCoreReceiveNoUnicastAnswers: NSECRecords not used"); FreeNSECRecords(m, NSECRecords); }
8655     if (SOARecord)   { LogInfo("mDNSCoreReceiveNoUnicastAnswers: SOARecord not used"); ReleaseCacheRecord(m, SOARecord); }
8656 }
8657 
8658 mDNSlocal void mDNSCorePrintStoredProxyRecords(mDNS *const m)
8659 {
8660     AuthRecord *rrPtr = mDNSNULL;
8661     LogSPS("Stored Proxy records :");
8662     for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8663     {
8664         LogSPS("%s", ARDisplayString(m, rrPtr));
8665     }
8666 }
8667 
8668 mDNSlocal mDNSBool mDNSCoreRegisteredProxyRecord(mDNS *const m, AuthRecord *rr)
8669 {
8670     AuthRecord *rrPtr = mDNSNULL;
8671 
8672     for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8673     {
8674         if (IdenticalResourceRecord(&rrPtr->resrec, &rr->resrec))
8675         {
8676             LogSPS("mDNSCoreRegisteredProxyRecord: Ignoring packet registered with sleep proxy : %s ", ARDisplayString(m, rr));
8677             return mDNStrue;
8678         }
8679     }
8680     mDNSCorePrintStoredProxyRecords(m);
8681     return mDNSfalse;
8682 }
8683 
8684 mDNSlocal CacheRecord* mDNSCoreReceiveCacheCheck(mDNS *const m, const DNSMessage *const response, uDNS_LLQType LLQType,
8685     const mDNSu32 slot, CacheGroup *cg, DNSQuestion *unicastQuestion, CacheRecord ***cfp, CacheRecord **NSECCachePtr,
8686     mDNSInterfaceID InterfaceID)
8687 {
8688     CacheRecord *rr;
8689     CacheRecord **cflocal = *cfp;
8690 
8691     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8692     {
8693         mDNSBool match;
8694         // Resource record received via unicast, the resGroupID should match ?
8695         if (!InterfaceID)
8696         {
8697             mDNSu16 id1 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
8698             mDNSu16 id2 = (m->rec.r.resrec.rDNSServer ? m->rec.r.resrec.rDNSServer->resGroupID : 0);
8699             match = (id1 == id2);
8700         }
8701         else
8702             match = (rr->resrec.InterfaceID == InterfaceID);
8703         // If we found this exact resource record, refresh its TTL
8704         if (match && IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
8705         {
8706             if (m->rec.r.resrec.rdlength > InlineCacheRDSize)
8707                 verbosedebugf("mDNSCoreReceiveCacheCheck: Found record size %5d interface %p already in cache: %s",
8708                               m->rec.r.resrec.rdlength, InterfaceID, CRDisplayString(m, &m->rec.r));
8709 
8710             if (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8711             {
8712                 // If this packet record has the kDNSClass_UniqueRRSet flag set, then add it to our cache flushing list
8713                 if (rr->NextInCFList == mDNSNULL && *cfp != &rr->NextInCFList && LLQType != uDNS_LLQ_Events)
8714                 {
8715                     *cflocal = rr;
8716                     cflocal = &rr->NextInCFList;
8717                     *cflocal = (CacheRecord*)1;
8718                     *cfp = &rr->NextInCFList;
8719                 }
8720 
8721                 // If this packet record is marked unique, and our previous cached copy was not, then fix it
8722                 if (!(rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))
8723                 {
8724                     DNSQuestion *q;
8725                     for (q = m->Questions; q; q=q->next)
8726                     {
8727                         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
8728                             q->UniqueAnswers++;
8729                     }
8730                     rr->resrec.RecordType = m->rec.r.resrec.RecordType;
8731                 }
8732             }
8733 
8734             if (!SameRDataBody(&m->rec.r.resrec, &rr->resrec.rdata->u, SameDomainNameCS))
8735             {
8736                 // If the rdata of the packet record differs in name capitalization from the record in our cache
8737                 // then mDNSPlatformMemSame will detect this. In this case, throw the old record away, so that clients get
8738                 // a 'remove' event for the record with the old capitalization, and then an 'add' event for the new one.
8739                 // <rdar://problem/4015377> mDNS -F returns the same domain multiple times with different casing
8740                 rr->resrec.rroriginalttl = 0;
8741                 rr->TimeRcvd = m->timenow;
8742                 rr->UnansweredQueries = MaxUnansweredQueries;
8743                 SetNextCacheCheckTimeForRecord(m, rr);
8744                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change old: %s", CRDisplayString(m, rr));
8745                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change new: %s", CRDisplayString(m, &m->rec.r));
8746                 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change in %d slot %3d in %d %d",
8747                         NextCacheCheckEvent(rr) - m->timenow, slot, m->rrcache_nextcheck[slot] - m->timenow, m->NextCacheCheck - m->timenow);
8748                 // DO NOT break out here -- we want to continue as if we never found it
8749             }
8750             else if (!IdenticalAnonInfo(m->rec.r.resrec.AnonInfo, rr->resrec.AnonInfo))
8751             {
8752                 // If the NSEC3 record changed, a few possibilities
8753                 //
8754                 // 1) the peer reinitialized e.g., after network change and still part of the
8755                 //    same set.
8756                 // 2) the peer went to a different set but we did not see the goodbyes. If we just
8757                 //    update the nsec3 record, it would be incorrect. Flush the cache so that we
8758                 //    can deliver a RMV followed by ADD.
8759                 // 3) if the peer is ourselves and we see the goodbye when moving to a different set
8760                 //    and so we flush the cache and create a new cache record with the new set information.
8761                 //    Now we move back to the original set. In this case, we can't just update the
8762                 //    NSEC3 record alone. We need to flush so that we can deliver an RMV followed by ADD
8763                 //    when we create the new cache entry.
8764                 //
8765                 // Note: For case (1), we could avoid flushing the cache but we can't tell the difference
8766                 // from the other cases.
8767                 rr->resrec.rroriginalttl = 0;
8768                 rr->TimeRcvd = m->timenow;
8769                 rr->UnansweredQueries = MaxUnansweredQueries;
8770                 SetNextCacheCheckTimeForRecord(m, rr);
8771                 LogInfo("mDNSCoreReceiveCacheCheck: AnonInfo changed for %s", CRDisplayString(m, rr));
8772                 // DO NOT break out here -- we want to continue as if we never found it. When we return
8773                 // from this function, we will create a new cache entry with the new NSEC3 record
8774             }
8775             else if (m->rec.r.resrec.rroriginalttl > 0)
8776             {
8777                 DNSQuestion *q;
8778 
8779                 m->mDNSStats.CacheRefreshed++;
8780 
8781                 if (rr->resrec.rroriginalttl == 0) debugf("uDNS rescuing %s", CRDisplayString(m, rr));
8782                 RefreshCacheRecord(m, rr, m->rec.r.resrec.rroriginalttl);
8783                 rr->responseFlags = response->h.flags;
8784 
8785                 // If we may have NSEC records returned with the answer (which we don't know yet as it
8786                 // has not been processed), we need to cache them along with the first cache
8787                 // record in the list that answers the question so that it can be used for validation
8788                 // later. The "type" check below is to make sure that we cache on the cache record
8789                 // that would answer the question. It is possible that we might cache additional things
8790                 // e.g., MX question might cache A records also, and we want to cache the NSEC on
8791                 // the record that answers the question.
8792                 if (response->h.numAnswers && unicastQuestion && unicastQuestion->qtype == rr->resrec.rrtype
8793                     && !(*NSECCachePtr))
8794                 {
8795                     LogInfo("mDNSCoreReceiveCacheCheck: rescuing RR %s", CRDisplayString(m, rr));
8796                     *NSECCachePtr = rr;
8797                 }
8798                 // We have to reset the question interval to MaxQuestionInterval so that we don't keep
8799                 // polling the network once we get a valid response back. For the first time when a new
8800                 // cache entry is created, AnswerCurrentQuestionWithResourceRecord does that.
8801                 // Subsequently, if we reissue questions from within the mDNSResponder e.g., DNS server
8802                 // configuration changed, without flushing the cache, we reset the question interval here.
8803                 // Currently, we do this for for both multicast and unicast questions as long as the record
8804                 // type is unique. For unicast, resource record is always unique and for multicast it is
8805                 // true for records like A etc. but not for PTR.
8806                 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8807                 {
8808                     for (q = m->Questions; q; q=q->next)
8809                     {
8810                         if (!q->DuplicateOf && !q->LongLived &&
8811                             ActiveQuestion(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
8812                         {
8813                             ResetQuestionState(m, q);
8814                             debugf("mDNSCoreReceiveCacheCheck: Set MaxQuestionInterval for %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
8815                             break;      // Why break here? Aren't there other questions we might want to look at?-- SC July 2010
8816                         }
8817                     }
8818                 }
8819                 break;
8820             }
8821             else
8822             {
8823                 // If the packet TTL is zero, that means we're deleting this record.
8824                 // To give other hosts on the network a chance to protest, we push the deletion
8825                 // out one second into the future. Also, we set UnansweredQueries to MaxUnansweredQueries.
8826                 // Otherwise, we'll do final queries for this record at 80% and 90% of its apparent
8827                 // lifetime (800ms and 900ms from now) which is a pointless waste of network bandwidth.
8828                 // If record's current expiry time is more than a second from now, we set it to expire in one second.
8829                 // If the record is already going to expire in less than one second anyway, we leave it alone --
8830                 // we don't want to let the goodbye packet *extend* the record's lifetime in our cache.
8831                 debugf("DE for %s", CRDisplayString(m, rr));
8832                 if (RRExpireTime(rr) - m->timenow > mDNSPlatformOneSecond)
8833                 {
8834                     rr->resrec.rroriginalttl = 1;
8835                     rr->TimeRcvd = m->timenow;
8836                     rr->UnansweredQueries = MaxUnansweredQueries;
8837                     SetNextCacheCheckTimeForRecord(m, rr);
8838                 }
8839                 break;
8840             }
8841         }
8842     }
8843     return rr;
8844 }
8845 
8846 mDNSlocal void mDNSParseNSEC3Records(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end,
8847     const mDNSInterfaceID InterfaceID, CacheRecord **NSEC3Records)
8848 {
8849     const mDNSu8 *ptr;
8850     CacheRecord *rr;
8851     int i;
8852 
8853     if (!response->h.numAuthorities)
8854         return;
8855     ptr = LocateAuthorities(response, end);
8856     if (!ptr)
8857     {
8858         LogInfo("mDNSParseNSEC3Records: ERROR can't locate authorities");
8859         return;
8860     }
8861     for (i = 0; i < response->h.numAuthorities && ptr && ptr < end; i++)
8862     {
8863         CacheGroup *cg;
8864 
8865         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8866         if (!ptr || m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative || m->rec.r.resrec.rrtype != kDNSType_NSEC3)
8867         {
8868             debugf("mDNSParseNSEC3Records: ptr %p, Record %s, ignoring", ptr, CRDisplayString(m, &m->rec.r));
8869             m->rec.r.resrec.RecordType = 0;
8870             continue;
8871         }
8872         cg = CacheGroupForRecord(m, &m->rec.r.resrec);
8873         // Create the cache entry but don't add it to the cache it. We need
8874         // to cache this along with the main cache record.
8875         rr = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cg, 0, mDNSfalse, mDNSNULL);
8876         if (rr)
8877         {
8878             debugf("mDNSParseNSEC3Records: %s", CRDisplayString(m, rr));
8879             *NSEC3Records = rr;
8880             NSEC3Records = &rr->next;
8881         }
8882         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8883     }
8884 }
8885 
8886 mDNSlocal void mDNSCoreResetRecord(mDNS *const m)
8887 {
8888     m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
8889     if (m->rec.r.resrec.AnonInfo)
8890     {
8891         FreeAnonInfo(m->rec.r.resrec.AnonInfo);
8892         m->rec.r.resrec.AnonInfo = mDNSNULL;
8893     }
8894 }
8895 
8896 // Note: mDNSCoreReceiveResponse calls mDNS_Deregister_internal which can call a user callback, which may change
8897 // the record list and/or question list.
8898 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
8899 // InterfaceID non-NULL tells us the interface this multicast response was received on
8900 // InterfaceID NULL tells us this was a unicast response
8901 // dstaddr NULL tells us we received this over an outgoing TCP connection we made
8902 mDNSlocal void mDNSCoreReceiveResponse(mDNS *const m,
8903                                        const DNSMessage *const response, const mDNSu8 *end,
8904                                        const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
8905                                        const mDNSInterfaceID InterfaceID)
8906 {
8907     int i;
8908     mDNSBool ResponseMCast    = dstaddr && mDNSAddrIsDNSMulticast(dstaddr);
8909     mDNSBool ResponseSrcLocal = !srcaddr || mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
8910     DNSQuestion *llqMatch = mDNSNULL;
8911     DNSQuestion *unicastQuestion = mDNSNULL;
8912     uDNS_LLQType LLQType      = uDNS_recvLLQResponse(m, response, end, srcaddr, srcport, &llqMatch);
8913 
8914     // "(CacheRecord*)1" is a special (non-zero) end-of-list marker
8915     // We use this non-zero marker so that records in our CacheFlushRecords list will always have NextInCFList
8916     // set non-zero, and that tells GetCacheEntity() that they're not, at this moment, eligible for recycling.
8917     CacheRecord *CacheFlushRecords = (CacheRecord*)1;
8918     CacheRecord **cfp = &CacheFlushRecords;
8919     CacheRecord *NSECRecords = mDNSNULL;
8920     CacheRecord *NSECCachePtr = mDNSNULL;
8921     CacheRecord **nsecp = &NSECRecords;
8922     CacheRecord *McastNSEC3Records = mDNSNULL;
8923     mDNSBool nseclist;
8924     mDNSu8 rcode = '\0';
8925     mDNSBool rrsigsCreated = mDNSfalse;
8926     mDNSBool DNSSECQuestion = mDNSfalse;
8927     NetworkInterfaceInfo *llintf = FirstIPv4LLInterfaceForID(m, InterfaceID);
8928     mDNSBool    recordAcceptedInResponse = mDNSfalse; // Set if a record is accepted from a unicast mDNS response that answers an existing question.
8929 
8930     // All records in a DNS response packet are treated as equally valid statements of truth. If we want
8931     // to guard against spoof responses, then the only credible protection against that is cryptographic
8932     // security, e.g. DNSSEC., not worrying about which section in the spoof packet contained the record.
8933     int firstauthority  =                   response->h.numAnswers;
8934     int firstadditional = firstauthority  + response->h.numAuthorities;
8935     int totalrecords    = firstadditional + response->h.numAdditionals;
8936     const mDNSu8 *ptr   = response->data;
8937     DNSServer *uDNSServer = mDNSNULL;
8938 
8939     debugf("Received Response from %#-15a addressed to %#-15a on %p with "
8940            "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes LLQType %d",
8941            srcaddr, dstaddr, InterfaceID,
8942            response->h.numQuestions,   response->h.numQuestions   == 1 ? ", "   : "s,",
8943            response->h.numAnswers,     response->h.numAnswers     == 1 ? ", "   : "s,",
8944            response->h.numAuthorities, response->h.numAuthorities == 1 ? "y,  " : "ies,",
8945            response->h.numAdditionals, response->h.numAdditionals == 1 ? " "    : "s", end - response->data, LLQType);
8946 
8947     // According to RFC 2181 <http://www.ietf.org/rfc/rfc2181.txt>
8948     //    When a DNS client receives a reply with TC
8949     //    set, it should ignore that response, and query again, using a
8950     //    mechanism, such as a TCP connection, that will permit larger replies.
8951     // It feels wrong to be throwing away data after the network went to all the trouble of delivering it to us, but
8952     // delivering some records of the RRSet first and then the remainder a couple of milliseconds later was causing
8953     // failures in our Microsoft Active Directory client, which expects to get the entire set of answers at once.
8954     // <rdar://problem/6690034> Can't bind to Active Directory
8955     // In addition, if the client immediately canceled its query after getting the initial partial response, then we'll
8956     // abort our TCP connection, and not complete the operation, and end up with an incomplete RRSet in our cache.
8957     // Next time there's a query for this RRSet we'll see answers in our cache, and assume we have the whole RRSet already,
8958     // and not even do the TCP query.
8959     // Accordingly, if we get a uDNS reply with kDNSFlag0_TC set, we bail out and wait for the TCP response containing the entire RRSet.
8960     if (!InterfaceID && (response->h.flags.b[0] & kDNSFlag0_TC)) return;
8961 
8962     if (LLQType == uDNS_LLQ_Ignore) return;
8963 
8964     // 1. We ignore questions (if any) in mDNS response packets
8965     // 2. If this is an LLQ response, we handle it much the same
8966     // 3. If we get a uDNS UDP response with the TC (truncated) bit set, then we can't treat this
8967     //    answer as being the authoritative complete RRSet, and respond by deleting all other
8968     //    matching cache records that don't appear in this packet.
8969     // Otherwise, this is a authoritative uDNS answer, so arrange for any stale records to be purged
8970     if (ResponseMCast || LLQType == uDNS_LLQ_Events || (response->h.flags.b[0] & kDNSFlag0_TC))
8971         ptr = LocateAnswers(response, end);
8972     // Otherwise, for one-shot queries, any answers in our cache that are not also contained
8973     // in this response packet are immediately deemed to be invalid.
8974     else
8975     {
8976         mDNSBool failure, returnEarly;
8977         rcode = (mDNSu8)(response->h.flags.b[1] & kDNSFlag1_RC_Mask);
8978         failure = !(rcode == kDNSFlag1_RC_NoErr || rcode == kDNSFlag1_RC_NXDomain || rcode == kDNSFlag1_RC_NotAuth);
8979         returnEarly = mDNSfalse;
8980         // We could possibly combine this with the similar loop at the end of this function --
8981         // instead of tagging cache records here and then rescuing them if we find them in the answer section,
8982         // we could instead use the "m->PktNum" mechanism to tag each cache record with the packet number in
8983         // which it was received (or refreshed), and then at the end if we find any cache records which
8984         // answer questions in this packet's question section, but which aren't tagged with this packet's
8985         // packet number, then we deduce they are old and delete them
8986         for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8987         {
8988             DNSQuestion q, *qptr = mDNSNULL;
8989             ptr = getQuestion(response, ptr, end, InterfaceID, &q);
8990             if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr)))
8991             {
8992                 if (!failure)
8993                 {
8994                     CacheRecord *rr;
8995                     // Remember the unicast question that we found, which we use to make caching
8996                     // decisions later on in this function
8997                     CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
8998                     if (!mDNSOpaque16IsZero(response->h.id))
8999                     {
9000                         unicastQuestion = qptr;
9001                         if (qptr->qDNSServer && DNSSECQuestion(qptr))
9002                         {
9003                             LogInfo("mDNSCoreReceiveResponse: Setting aware for %##s (%s) on %#a", qptr->qname.c,
9004                                 DNSTypeName(qptr->qtype), &qptr->qDNSServer->addr);
9005                             qptr->qDNSServer->DNSSECAware = mDNStrue;
9006                             qptr->qDNSServer->req_DO = mDNStrue;
9007                         }
9008                         if (qptr->ValidatingResponse)
9009                             DNSSECQuestion = mDNStrue;
9010                     }
9011                     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
9012                         if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
9013                         {
9014                             debugf("uDNS marking %p %##s (%s) %p %s", q.InterfaceID, q.qname.c, DNSTypeName(q.qtype),
9015                                    rr->resrec.InterfaceID, CRDisplayString(m, rr));
9016                             // Don't want to disturb rroriginalttl here, because code below might need it for the exponential backoff doubling algorithm
9017                             rr->TimeRcvd          = m->timenow - TicksTTL(rr) - 1;
9018                             rr->UnansweredQueries = MaxUnansweredQueries;
9019                             rr->CRDNSSECQuestion = 0;
9020                             if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9021                             {
9022                                 LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for record %s, question %##s (%s)", CRDisplayString(m, rr),
9023                                     unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9024                                 rr->CRDNSSECQuestion = 1;
9025                             }
9026                         }
9027                 }
9028                 else
9029                 {
9030                     if (qptr)
9031                     {
9032                         // If we recv any error from the DNSServer for a DNSSEC Query and if we know that the server
9033                         // is not DNSSEC aware, stop doing DNSSEC for that DNSServer. Note that by setting the
9034                         // req_DO to false here, the next retransmission for this question will turn off validation
9035                         // and hence retransmit without the EDNS0/DOK option.
9036                         if (DNSSECOptionalQuestion(qptr) && qptr->qDNSServer && !qptr->qDNSServer->DNSSECAware)
9037                         {
9038                             LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to DNSSEC Query %##s (%s), clear DO flag",
9039                                     qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9040                             qptr->qDNSServer->req_DO = mDNSfalse;
9041                         }
9042                         // For Unicast DNS Queries, penalize the DNSServer
9043                         else
9044                         {
9045                             LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to query %##s (%s)",
9046                                     qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9047                             PenalizeDNSServer(m, qptr, response->h.flags);
9048                         }
9049                     }
9050                     returnEarly = mDNStrue;
9051                 }
9052             }
9053         }
9054         if (returnEarly)
9055         {
9056             LogInfo("Ignoring %2d Answer%s %2d Authorit%s %2d Additional%s",
9057                     response->h.numAnswers,     response->h.numAnswers     == 1 ? ", " : "s,",
9058                     response->h.numAuthorities, response->h.numAuthorities == 1 ? "y,  " : "ies,",
9059                     response->h.numAdditionals, response->h.numAdditionals == 1 ? "" : "s");
9060             // not goto exit because we won't have any CacheFlushRecords and we do not want to
9061             // generate negative cache entries (we want to query the next server)
9062             return;
9063         }
9064         if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9065         {
9066             BumpDNSSECStats(m, kStatsActionSet, kStatsTypeMsgSize, (end - response->data));
9067         }
9068     }
9069 
9070     // Parse the NSEC3 records from the Authority section before we process
9071     // the Answer section so that we can cache them along with the proper
9072     // cache records we create.
9073     if (mDNSOpaque16IsZero(response->h.id))
9074         mDNSParseNSEC3Records(m, response, end, InterfaceID, &McastNSEC3Records);
9075 
9076     for (i = 0; i < totalrecords && ptr && ptr < end; i++)
9077     {
9078         // All responses sent via LL multicast are acceptable for caching
9079         // All responses received over our outbound TCP connections are acceptable for caching
9080         // We accept all records in a unicast response to a multicast query once we find one that
9081         // answers an active question.
9082         mDNSBool AcceptableResponse = ResponseMCast || !dstaddr || LLQType || recordAcceptedInResponse;
9083         // (Note that just because we are willing to cache something, that doesn't necessarily make it a trustworthy answer
9084         // to any specific question -- any code reading records from the cache needs to make that determination for itself.)
9085 
9086         const mDNSu8 RecordType =
9087             (i < firstauthority ) ? (mDNSu8)kDNSRecordTypePacketAns  :
9088             (i < firstadditional) ? (mDNSu8)kDNSRecordTypePacketAuth : (mDNSu8)kDNSRecordTypePacketAdd;
9089         ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, RecordType, &m->rec);
9090         if (!ptr) goto exit;        // Break out of the loop and clean up our CacheFlushRecords list before exiting
9091 
9092         if (m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative)
9093         {
9094             mDNSCoreResetRecord(m);
9095             continue;
9096         }
9097 
9098         // We have already parsed the NSEC3 records and cached them approrpriately for
9099         // multicast responses.
9100         if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype == kDNSType_NSEC3)
9101         {
9102             mDNSCoreResetRecord(m);
9103             continue;
9104         }
9105         // Don't want to cache OPT or TSIG pseudo-RRs
9106         if (m->rec.r.resrec.rrtype == kDNSType_TSIG)
9107         {
9108             mDNSCoreResetRecord(m);
9109             continue;
9110         }
9111         if (m->rec.r.resrec.rrtype == kDNSType_OPT)
9112         {
9113             const rdataOPT *opt;
9114             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
9115             // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
9116             // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
9117             for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
9118                 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
9119                 {
9120                     ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
9121                     ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
9122                 }
9123             mDNSCoreResetRecord(m);
9124             continue;
9125         }
9126         // if a CNAME record points to itself, then don't add it to the cache
9127         if ((m->rec.r.resrec.rrtype == kDNSType_CNAME) && SameDomainName(m->rec.r.resrec.name, &m->rec.r.resrec.rdata->u.name))
9128         {
9129             LogInfo("mDNSCoreReceiveResponse: CNAME loop domain name %##s", m->rec.r.resrec.name->c);
9130             mDNSCoreResetRecord(m);
9131             continue;
9132         }
9133 
9134         // When we receive uDNS LLQ responses, we assume a long cache lifetime --
9135         // In the case of active LLQs, we'll get remove events when the records actually do go away
9136         // In the case of polling LLQs, we assume the record remains valid until the next poll
9137         if (!mDNSOpaque16IsZero(response->h.id))
9138             m->rec.r.resrec.rroriginalttl = GetEffectiveTTL(LLQType, m->rec.r.resrec.rroriginalttl);
9139 
9140         // If response was not sent via LL multicast,
9141         // then see if it answers a recent query of ours, which would also make it acceptable for caching.
9142         if (!ResponseMCast)
9143         {
9144             if (LLQType)
9145             {
9146                 // For Long Lived queries that are both sent over UDP and Private TCP, LLQType is set.
9147                 // Even though it is AcceptableResponse, we need a matching DNSServer pointer for the
9148                 // queries to get ADD/RMV events. To lookup the question, we can't use
9149                 // ExpectingUnicastResponseForRecord as the port numbers don't match. uDNS_recvLLQRespose
9150                 // has already matched the question using the 64 bit Id in the packet and we use that here.
9151 
9152                 if (llqMatch != mDNSNULL) m->rec.r.resrec.rDNSServer = uDNSServer = llqMatch->qDNSServer;
9153 
9154                 // If this is a DNSSEC question that is also LongLived, don't accept records from the
9155                 // Additional/Authority section blindly. We need to go through IsAcceptableResponse below
9156                 // so that NSEC/NSEC3 record are cached in the nseclist if we accept them. This can happen
9157                 // for both negative responses and wildcard expanded positive responses as both of come
9158                 // back with NSEC/NSEC3s.
9159                 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9160                     AcceptableResponse = mDNSfalse;
9161             }
9162             else if (!AcceptableResponse || !dstaddr)
9163             {
9164                 // For responses that come over TCP (Responses that can't fit within UDP) or TLS (Private queries
9165                 // that are not long lived e.g., AAAA lookup in a Private domain), it is indicated by !dstaddr.
9166                 // Even though it is AcceptableResponse, we still need a DNSServer pointer for the resource records that
9167                 // we create.
9168 
9169                 DNSQuestion *q = ExpectingUnicastResponseForRecord(m, srcaddr, ResponseSrcLocal, dstport, response->h.id, &m->rec.r, !dstaddr);
9170 
9171                 // Initialize the DNS server on the resource record which will now filter what questions we answer with
9172                 // this record.
9173                 //
9174                 // We could potentially lookup the DNS server based on the source address, but that may not work always
9175                 // and that's why ExpectingUnicastResponseForRecord does not try to verify whether the response came
9176                 // from the DNS server that queried. We follow the same logic here. If we can find a matching quetion based
9177                 // on the "id" and "source port", then this response answers the question and assume the response
9178                 // came from the same DNS server that we sent the query to.
9179 
9180                 if (q != mDNSNULL)
9181                 {
9182                     AcceptableResponse = mDNStrue;
9183                     if (!InterfaceID)
9184                     {
9185                         debugf("mDNSCoreReceiveResponse: InterfaceID %p %##s (%s)", q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
9186                         m->rec.r.resrec.rDNSServer = uDNSServer = q->qDNSServer;
9187                     }
9188                     else
9189                     {
9190                         // Accept all remaining records in this unicast response to an mDNS query.
9191                         recordAcceptedInResponse = mDNStrue;
9192                         LogInfo("mDNSCoreReceiveResponse: Accepting response for query: %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
9193                     }
9194                 }
9195                 else
9196                 {
9197                     // If we can't find a matching question, we need to see whether we have seen records earlier that matched
9198                     // the question. The code below does that. So, make this record unacceptable for now
9199                     if (!InterfaceID)
9200                     {
9201                         debugf("mDNSCoreReceiveResponse: Can't find question for record name %##s", m->rec.r.resrec.name->c);
9202                         AcceptableResponse = mDNSfalse;
9203                     }
9204                 }
9205             }
9206         }
9207         else if (llintf && llintf->IgnoreIPv4LL && m->rec.r.resrec.rrtype == kDNSType_A)
9208         {
9209             // There are some routers (rare, thankfully) that generate bogus ARP responses for
9210             // any IPv4 address they don’t recognize, including RFC 3927 IPv4 link-local addresses.
9211             // To work with these broken routers, client devices need to blacklist these broken
9212             // routers and ignore their bogus ARP responses. Some devices implement a technique
9213             // such as the one described in US Patent 7436783, which lets clients detect and
9214             // ignore these broken routers: <https://www.google.com/patents/US7436783>
9215 
9216             // OS X and iOS do not implement this defensive mechanism, instead taking a simpler
9217             // approach of just detecting these broken routers and completely disabling IPv4
9218             // link-local communication on interfaces where a broken router is detected.
9219             // OS X and iOS set the IFEF_ARPLL interface flag on interfaces
9220             // that are deemed “safe” for IPv4 link-local communication;
9221             // the flag is cleared on interfaces where a broken router is detected.
9222 
9223             // OS X and iOS will not even try to communicate with an IPv4
9224             // link-local destination on an interface without the IFEF_ARPLL flag set.
9225             // This can cause some badly written applications to freeze for a long time if they
9226             // attempt to connect to an IPv4 link-local destination address and then wait for
9227             // that connection attempt to time out before trying other candidate addresses.
9228 
9229             // To mask this client bug, we suppress acceptance of IPv4 link-local address
9230             // records on interfaces where we know the OS will be unwilling even to attempt
9231             // communication with those IPv4 link-local destination addresses.
9232             // <rdar://problem/9400639> kSuppress IPv4LL answers on interfaces without IFEF_ARPLL
9233 
9234             const CacheRecord *const rr = &m->rec.r;
9235             const RDataBody2 *const rdb = (RDataBody2 *)rr->smallrdatastorage.data;
9236             if (mDNSv4AddressIsLinkLocal(&rdb->ipv4))
9237             {
9238                 LogInfo("mDNSResponder: Dropping LinkLocal packet %s", CRDisplayString(m, &m->rec.r));
9239                 mDNSCoreResetRecord(m);
9240                 continue;
9241             }
9242         }
9243 
9244         // 1. Check that this packet resource record does not conflict with any of ours
9245         if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype != kDNSType_NSEC)
9246         {
9247             if (m->CurrentRecord)
9248                 LogMsg("mDNSCoreReceiveResponse ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
9249             m->CurrentRecord = m->ResourceRecords;
9250             while (m->CurrentRecord)
9251             {
9252                 AuthRecord *rr = m->CurrentRecord;
9253                 m->CurrentRecord = rr->next;
9254                 // We accept all multicast responses, and unicast responses resulting from queries we issued
9255                 // For other unicast responses, this code accepts them only for responses with an
9256                 // (apparently) local source address that pertain to a record of our own that's in probing state
9257                 if (!AcceptableResponse && !(ResponseSrcLocal && rr->resrec.RecordType == kDNSRecordTypeUnique)) continue;
9258 
9259                 if (PacketRRMatchesSignature(&m->rec.r, rr))        // If interface, name, type (if shared record) and class match...
9260                 {
9261                     // ... check to see if type and rdata are identical
9262                     if (IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
9263                     {
9264                         // If the RR in the packet is identical to ours, just check they're not trying to lower the TTL on us
9265                         if (m->rec.r.resrec.rroriginalttl >= rr->resrec.rroriginalttl/2 || m->SleepState)
9266                         {
9267                             // If we were planning to send on this -- and only this -- interface, then we don't need to any more
9268                             if      (rr->ImmedAnswer == InterfaceID) { rr->ImmedAnswer = mDNSNULL; rr->ImmedUnicast = mDNSfalse; }
9269                         }
9270                         else
9271                         {
9272                             if      (rr->ImmedAnswer == mDNSNULL)    { rr->ImmedAnswer = InterfaceID;       m->NextScheduledResponse = m->timenow; }
9273                             else if (rr->ImmedAnswer != InterfaceID) { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9274                         }
9275                     }
9276                     // else, the packet RR has different type or different rdata -- check to see if this is a conflict
9277                     else if (m->rec.r.resrec.rroriginalttl > 0 && PacketRRConflict(m, rr, &m->rec.r))
9278                     {
9279                         LogInfo("mDNSCoreReceiveResponse: Pkt Record: %08lX %s", m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
9280                         LogInfo("mDNSCoreReceiveResponse: Our Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9281 
9282                         // If this record is marked DependentOn another record for conflict detection purposes,
9283                         // then *that* record has to be bumped back to probing state to resolve the conflict
9284                         if (rr->DependentOn)
9285                         {
9286                             while (rr->DependentOn) rr = rr->DependentOn;
9287                             LogInfo("mDNSCoreReceiveResponse: Dep Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9288                         }
9289 
9290                         // If we've just whacked this record's ProbeCount, don't need to do it again
9291                         if (rr->ProbeCount > DefaultProbeCountForTypeUnique)
9292                             LogInfo("mDNSCoreReceiveResponse: Already reset to Probing: %s", ARDisplayString(m, rr));
9293                         else if (rr->ProbeCount == DefaultProbeCountForTypeUnique)
9294                             LogInfo("mDNSCoreReceiveResponse: Ignoring response received before we even began probing: %s", ARDisplayString(m, rr));
9295                         else
9296                         {
9297                             LogMsg("mDNSCoreReceiveResponse: Received from %#a:%d %s", srcaddr, mDNSVal16(srcport), CRDisplayString(m, &m->rec.r));
9298                             // If we'd previously verified this record, put it back to probing state and try again
9299                             if (rr->resrec.RecordType == kDNSRecordTypeVerified)
9300                             {
9301                                 LogMsg("mDNSCoreReceiveResponse: Resetting to Probing: %s", ARDisplayString(m, rr));
9302                                 rr->resrec.RecordType     = kDNSRecordTypeUnique;
9303                                 // We set ProbeCount to one more than the usual value so we know we've already touched this record.
9304                                 // This is because our single probe for "example-name.local" could yield a response with (say) two A records and
9305                                 // three AAAA records in it, and we don't want to call RecordProbeFailure() five times and count that as five conflicts.
9306                                 // This special value is recognised and reset to DefaultProbeCountForTypeUnique in SendQueries().
9307                                 rr->ProbeCount     = DefaultProbeCountForTypeUnique + 1;
9308                                 rr->AnnounceCount  = InitialAnnounceCount;
9309                                 InitializeLastAPTime(m, rr);
9310                                 RecordProbeFailure(m, rr);  // Repeated late conflicts also cause us to back off to the slower probing rate
9311                             }
9312                             // If we're probing for this record, we just failed
9313                             else if (rr->resrec.RecordType == kDNSRecordTypeUnique)
9314                             {
9315 	                            // At this point in the code, we're probing for uniqueness.
9316 	                            // We've sent at least one probe (rr->ProbeCount < DefaultProbeCountForTypeUnique)
9317 	                            // but we haven't completed probing yet (rr->resrec.RecordType == kDNSRecordTypeUnique).
9318                                 // Before we call deregister, check if this is a packet we registered with the sleep proxy.
9319                                 if (!mDNSCoreRegisteredProxyRecord(m, rr))
9320                                 {
9321                                     // This may be a conflict due to stale packets on the network. Delay probing by a second.
9322                                     // If there are conflicts after 3 such attempts, then it is a true conflict.
9323                                     if (m->DelayConflictProcessing)
9324                                     {
9325                                         m->DelayConflictProcessing--;
9326                                         LogMsg("Possible spurious conflict for %s. Attempt %d at suppressing probes for one second",
9327                                                ARDisplayString(m, rr), (MAX_CONFLICT_PROCESSING_DELAYS - m->DelayConflictProcessing));
9328                                         rr->ProbeCount     = DefaultProbeCountForTypeUnique + 1;
9329                                         rr->AnnounceCount  = InitialAnnounceCount;
9330                                         m->SuppressProbes  = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9331                                         InitializeLastAPTime(m, rr);
9332                                         RecordProbeFailure(m, rr);  // Repeated late conflicts also cause us to back off to the slower probing rate
9333                                     }
9334                                     else
9335                                     {
9336                                         LogMsg("mDNSCoreReceiveResponse: ProbeCount %d; will deregister %s", rr->ProbeCount, ARDisplayString(m, rr));
9337                                         m->mDNSStats.NameConflicts++;
9338 #if APPLE_OSX_mDNSResponder
9339                                         // See if this record was also registered with any D2D plugins.
9340                                         D2D_stop_advertising_record(rr);
9341 #endif
9342                                         mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9343                                     }
9344 
9345                                 }
9346                             }
9347                             // We assumed this record must be unique, but we were wrong. (e.g. There are two mDNSResponders on the
9348                             // same machine giving different answers for the reverse mapping record, or there are two machines on the
9349                             // network using the same IP address.) This is simply a misconfiguration, and there's nothing we can do
9350                             // to fix it -- e.g. it's not our job to be trying to change the machine's IP address. We just discard our
9351                             // record to avoid continued conflicts (as we do for a conflict on our Unique records) and get on with life.
9352                             else if (rr->resrec.RecordType == kDNSRecordTypeKnownUnique)
9353                             {
9354                                 LogMsg("mDNSCoreReceiveResponse: Unexpected conflict discarding %s", ARDisplayString(m, rr));
9355                                 m->mDNSStats.KnownUniqueNameConflicts++;
9356 #if APPLE_OSX_mDNSResponder
9357                                 D2D_stop_advertising_record(rr);
9358 #endif
9359                                 mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9360                             }
9361                             else
9362                                 LogMsg("mDNSCoreReceiveResponse: Unexpected record type %X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
9363                         }
9364                     }
9365                     // Else, matching signature, different type or rdata, but not a considered a conflict.
9366                     // If the packet record has the cache-flush bit set, then we check to see if we
9367                     // have any record(s) of the same type that we should re-assert to rescue them
9368                     // (see note about "multi-homing and bridged networks" at the end of this function).
9369                     else if (m->rec.r.resrec.rrtype == rr->resrec.rrtype)
9370                         if ((m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (mDNSu32)(m->timenow - rr->LastMCTime) > (mDNSu32)mDNSPlatformOneSecond/2)
9371                         { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9372                 }
9373             }
9374         }
9375 
9376         nseclist = mDNSfalse;
9377         if (!AcceptableResponse)
9378         {
9379             AcceptableResponse = IsResponseAcceptable(m, CacheFlushRecords, unicastQuestion, &nseclist);
9380             if (AcceptableResponse) m->rec.r.resrec.rDNSServer = uDNSServer;
9381         }
9382 
9383         // 2. See if we want to add this packet resource record to our cache
9384         // We only try to cache answers if we have a cache to put them in
9385         // Also, we ignore any apparent attempts at cache poisoning unicast to us that do not answer any outstanding active query
9386         if (!AcceptableResponse) LogInfo("mDNSCoreReceiveResponse ignoring %s", CRDisplayString(m, &m->rec.r));
9387         if (m->rrcache_size && AcceptableResponse)
9388         {
9389             const mDNSu32 slot = HashSlotFromNameHash(m->rec.r.resrec.namehash);
9390             CacheGroup *cg = CacheGroupForRecord(m, &m->rec.r.resrec);
9391             CacheRecord *rr = mDNSNULL;
9392 
9393             if (McastNSEC3Records)
9394                 InitializeAnonInfoForCR(m, &McastNSEC3Records, &m->rec.r);
9395 
9396             // 2a. Check if this packet resource record is already in our cache.
9397             //
9398             // If this record should go in the nseclist, don't look in the cache for updating it.
9399             // They are supposed to be cached under the "nsec" field of the cache record for
9400             // validation. Just create the cache record.
9401             if (!nseclist)
9402             {
9403                 rr = mDNSCoreReceiveCacheCheck(m, response, LLQType, slot, cg, unicastQuestion, &cfp, &NSECCachePtr, InterfaceID);
9404             }
9405 
9406             // If packet resource record not in our cache, add it now
9407             // (unless it is just a deletion of a record we never had, in which case we don't care)
9408             if (!rr && m->rec.r.resrec.rroriginalttl > 0)
9409             {
9410                 const mDNSBool AddToCFList = (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (LLQType != uDNS_LLQ_Events);
9411                 mDNSs32 delay;
9412 
9413                 if (AddToCFList)
9414                     delay = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9415                 else
9416                     delay = CheckForSoonToExpireRecords(m, m->rec.r.resrec.name, m->rec.r.resrec.namehash, mDNSNULL);
9417 
9418                 // If unique, assume we may have to delay delivery of this 'add' event.
9419                 // Below, where we walk the CacheFlushRecords list, we either call CacheRecordDeferredAdd()
9420                 // to immediately to generate answer callbacks, or we call ScheduleNextCacheCheckTime()
9421                 // to schedule an mDNS_Execute task at the appropriate time.
9422                 rr = CreateNewCacheEntry(m, slot, cg, delay, !nseclist, srcaddr);
9423                 if (rr)
9424                 {
9425                     rr->responseFlags = response->h.flags;
9426                     // If we are not creating signatures, then we need to inform DNSSEC so that
9427                     // it does not wait forever. Don't do this if we got NSEC records
9428                     // as it indicates that this name does not exist.
9429                     if (rr->resrec.rrtype == kDNSType_RRSIG && !nseclist)
9430                     {
9431                         rrsigsCreated = mDNStrue;
9432                     }
9433                     // Remember whether we created a cache record in response to a DNSSEC question.
9434                     // This helps DNSSEC code not to reissue the question to fetch the DNSSEC records.
9435                     rr->CRDNSSECQuestion = 0;
9436                     if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9437                     {
9438                         LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for new record %s, question %##s (%s)", CRDisplayString(m, rr),
9439                             unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9440                         rr->CRDNSSECQuestion = 1;
9441                     }
9442                     // NSEC/NSEC3 records and its signatures are cached with the negative cache entry
9443                     // which we should be creating below. It is also needed in the wildcard
9444                     // expanded answer case and in that case it is cached along with the answer.
9445                     if (nseclist)
9446                     {
9447                         rr->TimeRcvd = m->timenow;
9448                         *nsecp = rr;
9449                         nsecp = &rr->next;
9450                     }
9451                     else if (AddToCFList)
9452                     {
9453                         *cfp = rr;
9454                         cfp = &rr->NextInCFList;
9455                         *cfp = (CacheRecord*)1;
9456                     }
9457                     else if (rr->DelayDelivery)
9458                     {
9459                         ScheduleNextCacheCheckTime(m, slot, rr->DelayDelivery);
9460                     }
9461                 }
9462             }
9463             else
9464             {
9465                 if (rr && rr->resrec.AnonInfo && m->rec.r.resrec.AnonInfo)
9466                 {
9467                     CopyAnonInfoForCR(m, rr, &m->rec.r);
9468                 }
9469             }
9470         }
9471         mDNSCoreResetRecord(m);
9472     }
9473 
9474 exit:
9475     mDNSCoreResetRecord(m);
9476 
9477     // If we've just received one or more records with their cache flush bits set,
9478     // then scan that cache slot to see if there are any old stale records we need to flush
9479     while (CacheFlushRecords != (CacheRecord*)1)
9480     {
9481         CacheRecord *r1 = CacheFlushRecords, *r2;
9482         const mDNSu32 slot = HashSlotFromNameHash(r1->resrec.namehash);
9483         const CacheGroup *cg = CacheGroupForRecord(m, &r1->resrec);
9484         CacheFlushRecords = CacheFlushRecords->NextInCFList;
9485         r1->NextInCFList = mDNSNULL;
9486 
9487         // Look for records in the cache with the same signature as this new one with the cache flush
9488         // bit set, and either (a) if they're fresh, just make sure the whole RRSet has the same TTL
9489         // (as required by DNS semantics) or (b) if they're old, mark them for deletion in one second.
9490         // We make these TTL adjustments *only* for records that still have *more* than one second
9491         // remaining to live. Otherwise, a record that we tagged for deletion half a second ago
9492         // (and now has half a second remaining) could inadvertently get its life extended, by either
9493         // (a) if we got an explicit goodbye packet half a second ago, the record would be considered
9494         // "fresh" and would be incorrectly resurrected back to the same TTL as the rest of the RRSet,
9495         // or (b) otherwise, the record would not be fully resurrected, but would be reset to expire
9496         // in one second, thereby inadvertently delaying its actual expiration, instead of hastening it.
9497         // If this were to happen repeatedly, the record's expiration could be deferred indefinitely.
9498         // To avoid this, we need to ensure that the cache flushing operation will only act to
9499         // *decrease* a record's remaining lifetime, never *increase* it.
9500         for (r2 = cg ? cg->members : mDNSNULL; r2; r2=r2->next)
9501         {
9502             mDNSu16 id1;
9503             mDNSu16 id2;
9504             if (!r1->resrec.InterfaceID)
9505             {
9506                 id1 = (r1->resrec.rDNSServer ? r1->resrec.rDNSServer->resGroupID : 0);
9507                 id2 = (r2->resrec.rDNSServer ? r2->resrec.rDNSServer->resGroupID : 0);
9508             }
9509             else
9510             {
9511                 id1 = id2 = 0;
9512             }
9513             // When we receive new RRSIGs e.g., for DNSKEY record, we should not flush the old
9514             // RRSIGS e.g., for TXT record. To do so, we need to look at the typeCovered field of
9515             // the new RRSIG that we received. Process only if the typeCovered matches.
9516             if ((r1->resrec.rrtype == r2->resrec.rrtype) && (r1->resrec.rrtype == kDNSType_RRSIG))
9517             {
9518                 rdataRRSig *rrsig1 = (rdataRRSig *)(((RDataBody2 *)(r1->resrec.rdata->u.data))->data);
9519                 rdataRRSig *rrsig2 = (rdataRRSig *)(((RDataBody2 *)(r2->resrec.rdata->u.data))->data);
9520                 if (swap16(rrsig1->typeCovered) != swap16(rrsig2->typeCovered))
9521                 {
9522                     debugf("mDNSCoreReceiveResponse: Received RRSIG typeCovered %s, found %s, not processing",
9523                         DNSTypeName(swap16(rrsig1->typeCovered)), DNSTypeName(swap16(rrsig2->typeCovered)));
9524                     continue;
9525                 }
9526             }
9527 
9528             // For Unicast (null InterfaceID) the resolver IDs should also match
9529             if ((r1->resrec.InterfaceID == r2->resrec.InterfaceID) &&
9530                 (r1->resrec.InterfaceID || (id1 == id2)) &&
9531                 r1->resrec.rrtype      == r2->resrec.rrtype &&
9532                 r1->resrec.rrclass     == r2->resrec.rrclass)
9533             {
9534                 // If record is recent, just ensure the whole RRSet has the same TTL (as required by DNS semantics)
9535                 // else, if record is old, mark it to be flushed
9536                 if (m->timenow - r2->TimeRcvd < mDNSPlatformOneSecond && RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9537                 {
9538                     // If we find mismatched TTLs in an RRSet, correct them.
9539                     // We only do this for records with a TTL of 2 or higher. It's possible to have a
9540                     // goodbye announcement with the cache flush bit set (or a case-change on record rdata,
9541                     // which we treat as a goodbye followed by an addition) and in that case it would be
9542                     // inappropriate to synchronize all the other records to a TTL of 0 (or 1).
9543 
9544                     // We suppress the message for the specific case of correcting from 240 to 60 for type TXT,
9545                     // because certain early Bonjour devices are known to have this specific mismatch, and
9546                     // there's no point filling syslog with messages about something we already know about.
9547                     // We also don't log this for uDNS responses, since a caching name server is obliged
9548                     // to give us an aged TTL to correct for how long it has held the record,
9549                     // so our received TTLs are expected to vary in that case
9550 
9551                     // We also suppress log message in the case of SRV records that are received
9552                     // with a TTL of 4500 that are already cached with a TTL of 120 seconds, since
9553                     // this behavior was observed for a number of discoveryd based AppleTV's in iOS 8
9554                     // GM builds.
9555                     if (r2->resrec.rroriginalttl != r1->resrec.rroriginalttl && r1->resrec.rroriginalttl > 1)
9556                     {
9557                         if (!(r2->resrec.rroriginalttl == 240 && r1->resrec.rroriginalttl == 60 && r2->resrec.rrtype == kDNSType_TXT) &&
9558                             !(r2->resrec.rroriginalttl == 120 && r1->resrec.rroriginalttl == 4500 && r2->resrec.rrtype == kDNSType_SRV) &&
9559                             mDNSOpaque16IsZero(response->h.id))
9560                             LogInfo("Correcting TTL from %4d to %4d for %s",
9561                                     r2->resrec.rroriginalttl, r1->resrec.rroriginalttl, CRDisplayString(m, r2));
9562                         r2->resrec.rroriginalttl = r1->resrec.rroriginalttl;
9563                     }
9564                     r2->TimeRcvd = m->timenow;
9565                 }
9566                 else                // else, if record is old, mark it to be flushed
9567                 {
9568                     verbosedebugf("Cache flush new %p age %d expire in %d %s", r1, m->timenow - r1->TimeRcvd, RRExpireTime(r1) - m->timenow, CRDisplayString(m, r1));
9569                     verbosedebugf("Cache flush old %p age %d expire in %d %s", r2, m->timenow - r2->TimeRcvd, RRExpireTime(r2) - m->timenow, CRDisplayString(m, r2));
9570                     // We set stale records to expire in one second.
9571                     // This gives the owner a chance to rescue it if necessary.
9572                     // This is important in the case of multi-homing and bridged networks:
9573                     //   Suppose host X is on Ethernet. X then connects to an AirPort base station, which happens to be
9574                     //   bridged onto the same Ethernet. When X announces its AirPort IP address with the cache-flush bit
9575                     //   set, the AirPort packet will be bridged onto the Ethernet, and all other hosts on the Ethernet
9576                     //   will promptly delete their cached copies of the (still valid) Ethernet IP address record.
9577                     //   By delaying the deletion by one second, we give X a change to notice that this bridging has
9578                     //   happened, and re-announce its Ethernet IP address to rescue it from deletion from all our caches.
9579 
9580                     // We set UnansweredQueries to MaxUnansweredQueries to avoid expensive and unnecessary
9581                     // final expiration queries for this record.
9582 
9583                     // If a record is deleted twice, first with an explicit DE record, then a second time by virtue of the cache
9584                     // flush bit on the new record replacing it, then we allow the record to be deleted immediately, without the usual
9585                     // one-second grace period. This improves responsiveness for mDNS_Update(), as used for things like iChat status updates.
9586                     // <rdar://problem/5636422> Updating TXT records is too slow
9587                     // We check for "rroriginalttl == 1" because we want to include records tagged by the "packet TTL is zero" check above,
9588                     // which sets rroriginalttl to 1, but not records tagged by the rdata case-change check, which sets rroriginalttl to 0.
9589                     if (r2->TimeRcvd == m->timenow && r2->resrec.rroriginalttl == 1 && r2->UnansweredQueries == MaxUnansweredQueries)
9590                     {
9591                         LogInfo("Cache flush for DE record %s", CRDisplayString(m, r2));
9592                         r2->resrec.rroriginalttl = 0;
9593                     }
9594                     else if (RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9595                     {
9596                         // We only set a record to expire in one second if it currently has *more* than a second to live
9597                         // If it's already due to expire in a second or less, we just leave it alone
9598                         r2->resrec.rroriginalttl = 1;
9599                         r2->UnansweredQueries = MaxUnansweredQueries;
9600                         r2->TimeRcvd = m->timenow - 1;
9601                         // We use (m->timenow - 1) instead of m->timenow, because we use that to identify records
9602                         // that we marked for deletion via an explicit DE record
9603                     }
9604                 }
9605                 SetNextCacheCheckTimeForRecord(m, r2);
9606             }
9607         }
9608 
9609         if (r1->DelayDelivery)  // If we were planning to delay delivery of this record, see if we still need to
9610         {
9611             // If we had a unicast question for this response with at least one positive answer and we
9612             // have NSECRecords, it is most likely a wildcard expanded answer. Cache the NSEC and its
9613             // signatures along with the cache record which will be used for validation later. If
9614             // we rescued a few records earlier in this function, then NSECCachePtr would be set. In that
9615             // use that instead.
9616             if (response->h.numAnswers && unicastQuestion && NSECRecords)
9617             {
9618                 if (!NSECCachePtr)
9619                 {
9620                     LogInfo("mDNSCoreReceiveResponse: Updating NSECCachePtr to %s", CRDisplayString(m, r1));
9621                     NSECCachePtr = r1;
9622                 }
9623                 // Note: We need to do this before we call CacheRecordDeferredAdd as this
9624                 // might start the verification process which needs these NSEC records
9625                 if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9626                 {
9627                     LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9628                     FreeNSECRecords(m, NSECRecords);
9629                 }
9630                 NSECRecords = mDNSNULL;
9631                 NSECCachePtr = mDNSNULL;
9632             }
9633             r1->DelayDelivery = CheckForSoonToExpireRecords(m, r1->resrec.name, r1->resrec.namehash, mDNSNULL);
9634             // If no longer delaying, deliver answer now, else schedule delivery for the appropriate time
9635             if (!r1->DelayDelivery) CacheRecordDeferredAdd(m, r1);
9636             else ScheduleNextCacheCheckTime(m, slot, r1->DelayDelivery);
9637         }
9638     }
9639 
9640     // If we have not consumed the NSEC records yet e.g., just refreshing the cache,
9641     // update them now for future validations.
9642     if (NSECRecords && NSECCachePtr)
9643     {
9644         LogInfo("mDNSCoreReceieveResponse: Updating NSEC records in %s", CRDisplayString(m, NSECCachePtr));
9645         if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9646         {
9647             LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9648             FreeNSECRecords(m, NSECRecords);
9649         }
9650         NSECRecords = mDNSNULL;
9651         NSECCachePtr = mDNSNULL;
9652     }
9653 
9654     // If there is at least one answer and we did not create RRSIGs and there was a
9655     // ValidatingResponse question waiting for this response, give a hint that no RRSIGs
9656     // were created. We don't need to give a hint:
9657     //
9658     // - if we have no answers, the mDNSCoreReceiveNoUnicastAnswers below should
9659     //   generate a negative response
9660     //
9661     // - if we have NSECRecords, it means we might have a potential proof for
9662     //   non-existence of name that we are looking for
9663     //
9664     if (response->h.numAnswers && !rrsigsCreated && DNSSECQuestion && !NSECRecords)
9665         mDNSCoreReceiveNoDNSSECAnswers(m, response, end, dstaddr, dstport, InterfaceID);
9666 
9667     // See if we need to generate negative cache entries for unanswered unicast questions
9668     mDNSCoreReceiveNoUnicastAnswers(m, response, end, dstaddr, dstport, InterfaceID, LLQType, rcode, NSECRecords);
9669 
9670     if (McastNSEC3Records)
9671     {
9672         debugf("mDNSCoreReceiveResponse: McastNSEC3Records not used");
9673         FreeNSECRecords(m, McastNSEC3Records);
9674     }
9675 }
9676 
9677 // ScheduleWakeup causes all proxy records with WakeUp.HMAC matching mDNSEthAddr 'e' to be deregistered, causing
9678 // multiple wakeup magic packets to be sent if appropriate, and all records to be ultimately freed after a few seconds.
9679 // ScheduleWakeup is called on mDNS record conflicts, ARP conflicts, NDP conflicts, or reception of trigger traffic
9680 // that warrants waking the sleeping host.
9681 // ScheduleWakeup must be called with the lock held (ScheduleWakeupForList uses mDNS_Deregister_internal)
9682 
9683 mDNSlocal void ScheduleWakeupForList(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e, AuthRecord *const thelist)
9684 {
9685     // We need to use the m->CurrentRecord mechanism here when dealing with DuplicateRecords list as
9686     // mDNS_Deregister_internal deregisters duplicate records immediately as they are not used
9687     // to send wakeups or goodbyes. See the comment in that function for more details. To keep it
9688     // simple, we use the same mechanism for both lists.
9689     if (!e->l[0])
9690     {
9691         LogMsg("ScheduleWakeupForList ERROR: Target HMAC is zero");
9692         return;
9693     }
9694     m->CurrentRecord = thelist;
9695     while (m->CurrentRecord)
9696     {
9697         AuthRecord *const rr = m->CurrentRecord;
9698         if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering && mDNSSameEthAddress(&rr->WakeUp.HMAC, e))
9699         {
9700             LogInfo("ScheduleWakeupForList: Scheduling wakeup packets for %s", ARDisplayString(m, rr));
9701             mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
9702         }
9703         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
9704             m->CurrentRecord = rr->next;
9705     }
9706 }
9707 
9708 mDNSlocal void ScheduleWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e)
9709 {
9710     if (!e->l[0]) { LogMsg("ScheduleWakeup ERROR: Target HMAC is zero"); return; }
9711     ScheduleWakeupForList(m, InterfaceID, e, m->DuplicateRecords);
9712     ScheduleWakeupForList(m, InterfaceID, e, m->ResourceRecords);
9713 }
9714 
9715 mDNSlocal void SPSRecordCallback(mDNS *const m, AuthRecord *const ar, mStatus result)
9716 {
9717     if (result && result != mStatus_MemFree)
9718         LogInfo("SPS Callback %d %s", result, ARDisplayString(m, ar));
9719 
9720     if (result == mStatus_NameConflict)
9721     {
9722         mDNS_Lock(m);
9723         LogMsg("%-7s Conflicting mDNS -- waking %.6a %s", InterfaceNameForID(m, ar->resrec.InterfaceID), &ar->WakeUp.HMAC, ARDisplayString(m, ar));
9724         if (ar->WakeUp.HMAC.l[0])
9725         {
9726             SendWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.IMAC, &ar->WakeUp.password, mDNSfalse);  // Send one wakeup magic packet
9727             ScheduleWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.HMAC);                               // Schedule all other records with the same owner to be woken
9728         }
9729         mDNS_Unlock(m);
9730     }
9731 
9732     if (result == mStatus_NameConflict || result == mStatus_MemFree)
9733     {
9734         m->ProxyRecords--;
9735         mDNSPlatformMemFree(ar);
9736         mDNS_UpdateAllowSleep(m);
9737     }
9738 }
9739 
9740 mDNSlocal mDNSu8 *GetValueForMACAddr(mDNSu8 *ptr, mDNSu8 *limit, mDNSEthAddr *eth)
9741 {
9742     int     i;
9743     mDNSs8  hval   = 0;
9744     int     colons = 0;
9745     mDNSu8  val    = 0;
9746 
9747     for (i = 0; ptr < limit && *ptr != ' ' && i < 17; i++, ptr++)
9748     {
9749         hval = HexVal(*ptr);
9750         if (hval != -1)
9751         {
9752             val <<= 4;
9753             val |= hval;
9754         }
9755         else if (*ptr == ':')
9756         {
9757             if (colons >=5)
9758             {
9759                 LogMsg("GetValueForMACAddr: Address malformed colons %d val %d", colons, val);
9760                 return mDNSNULL;
9761             }
9762             eth->b[colons] = val;
9763             colons++;
9764             val = 0;
9765         }
9766     }
9767     if (colons != 5)
9768     {
9769         LogMsg("GetValueForMACAddr: Address malformed colons %d", colons);
9770         return mDNSNULL;
9771     }
9772     eth->b[colons] = val;
9773     return ptr;
9774 }
9775 
9776 mDNSlocal mDNSu8 *GetValueForIPv6Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv6Addr *v6)
9777 {
9778     int hval;
9779     int value;
9780     int numBytes;
9781     int digitsProcessed;
9782     int zeroFillStart;
9783     int numColons;
9784     mDNSu8 v6addr[16];
9785 
9786     // RFC 3513: Section 2.2 specifies IPv6 presentation format. The following parsing
9787     // handles both (1) and (2) and does not handle embedded IPv4 addresses.
9788     //
9789     // First forms a address in "v6addr", then expands to fill the zeroes in and returns
9790     // the result in "v6"
9791 
9792     numColons = numBytes = value = digitsProcessed = zeroFillStart = 0;
9793     while (ptr < limit && *ptr != ' ')
9794     {
9795         hval = HexVal(*ptr);
9796         if (hval != -1)
9797         {
9798             value <<= 4;
9799             value |= hval;
9800             digitsProcessed = 1;
9801         }
9802         else if (*ptr == ':')
9803         {
9804             if (!digitsProcessed)
9805             {
9806                 // If we have already seen a "::", we should not see one more. Handle the special
9807                 // case of "::"
9808                 if (numColons)
9809                 {
9810                     // if we never filled any bytes and the next character is space (we have reached the end)
9811                     // we are done
9812                     if (!numBytes && (ptr + 1) < limit && *(ptr + 1) == ' ')
9813                     {
9814                         mDNSPlatformMemZero(v6->b, 16);
9815                         return ptr + 1;
9816                     }
9817                     LogMsg("GetValueForIPv6Addr: zeroFillStart non-zero %d", zeroFillStart);
9818                     return mDNSNULL;
9819                 }
9820 
9821                 // We processed "::". We need to fill zeroes later. For now, mark the
9822                 // point where we will start filling zeroes from.
9823                 zeroFillStart = numBytes;
9824                 numColons++;
9825             }
9826             else if ((ptr + 1) < limit && *(ptr + 1) == ' ')
9827             {
9828                 // We have a trailing ":" i.e., no more characters after ":"
9829                 LogMsg("GetValueForIPv6Addr: Trailing colon");
9830                 return mDNSNULL;
9831             }
9832             else
9833             {
9834                 // For a fully expanded IPv6 address, we fill the 14th and 15th byte outside of this while
9835                 // loop below as there is no ":" at the end. Hence, the last two bytes that can possibly
9836                 // filled here is 12 and 13.
9837                 if (numBytes > 13) { LogMsg("GetValueForIPv6Addr:1: numBytes is %d", numBytes); return mDNSNULL; }
9838 
9839                 v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9840                 v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9841                 digitsProcessed = value = 0;
9842 
9843                 // Make sure that we did not fill the 13th and 14th byte above
9844                 if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:2: numBytes is %d", numBytes); return mDNSNULL; }
9845             }
9846         }
9847         ptr++;
9848     }
9849 
9850     // We should be processing the last set of bytes following the last ":" here
9851     if (!digitsProcessed)
9852     {
9853         LogMsg("GetValueForIPv6Addr: no trailing bytes after colon, numBytes is %d", numBytes);
9854         return mDNSNULL;
9855     }
9856 
9857     if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:3: numBytes is %d", numBytes); return mDNSNULL; }
9858     v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9859     v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9860 
9861     if (zeroFillStart)
9862     {
9863         int i, j, n;
9864         for (i = 0; i < zeroFillStart; i++)
9865             v6->b[i] = v6addr[i];
9866         for (j = i, n = 0; n < 16 - numBytes; j++, n++)
9867             v6->b[j] = 0;
9868         for (; j < 16; i++, j++)
9869             v6->b[j] = v6addr[i];
9870     }
9871     else if (numBytes == 16)
9872         mDNSPlatformMemCopy(v6->b, v6addr, 16);
9873     else
9874     {
9875         LogMsg("GetValueForIPv6addr: Not enough bytes for IPv6 address, numBytes is %d", numBytes);
9876         return mDNSNULL;
9877     }
9878     return ptr;
9879 }
9880 
9881 mDNSlocal mDNSu8 *GetValueForIPv4Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv4Addr *v4)
9882 {
9883     mDNSu32 val;
9884     int dots = 0;
9885     val = 0;
9886 
9887     for ( ; ptr < limit && *ptr != ' '; ptr++)
9888     {
9889         if (*ptr >= '0' &&  *ptr <= '9')
9890             val = val * 10 + *ptr - '0';
9891         else if (*ptr == '.')
9892         {
9893             if (val > 255 || dots >= 3)
9894             {
9895                 LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots);
9896                 return mDNSNULL;
9897             }
9898             v4->b[dots++] = val;
9899             val = 0;
9900         }
9901         else
9902         {
9903             // We have a zero at the end and if we reached that, then we are done.
9904             if (*ptr == 0 && ptr == limit - 1 && dots == 3)
9905             {
9906                 v4->b[dots] = val;
9907                 return ptr + 1;
9908             }
9909             else { LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots); return mDNSNULL; }
9910         }
9911     }
9912     if (dots != 3) { LogMsg("GetValueForIPv4Addr: Address malformed dots %d", dots); return mDNSNULL; }
9913     v4->b[dots] = val;
9914     return ptr;
9915 }
9916 
9917 mDNSlocal mDNSu8 *GetValueForKeepalive(mDNSu8 *ptr, mDNSu8 *limit, mDNSu32 *value)
9918 {
9919     mDNSu32 val;
9920 
9921     val = 0;
9922     for ( ; ptr < limit && *ptr != ' '; ptr++)
9923     {
9924         if (*ptr < '0' || *ptr > '9')
9925         {
9926             // We have a zero at the end and if we reached that, then we are done.
9927             if (*ptr == 0 && ptr == limit - 1)
9928             {
9929                 *value = val;
9930                 return ptr + 1;
9931             }
9932             else { LogMsg("GetValueForKeepalive: *ptr %d, ptr %p, limit %p, ptr +1 %d", *ptr, ptr, limit, *(ptr + 1)); return mDNSNULL; }
9933         }
9934         val = val * 10 + *ptr - '0';
9935     }
9936     *value = val;
9937     return ptr;
9938 }
9939 
9940 mDNSexport mDNSBool mDNSValidKeepAliveRecord(AuthRecord *rr)
9941 {
9942     mDNSAddr    laddr, raddr;
9943     mDNSEthAddr eth;
9944     mDNSIPPort  lport, rport;
9945     mDNSu32     timeout, seq, ack;
9946     mDNSu16     win;
9947 
9948     if (!mDNS_KeepaliveRecord(&rr->resrec))
9949     {
9950         return mDNSfalse;
9951     }
9952 
9953     timeout = seq = ack = 0;
9954     win = 0;
9955     laddr = raddr = zeroAddr;
9956     lport = rport = zeroIPPort;
9957     eth = zeroEthAddr;
9958 
9959     mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
9960 
9961     if (mDNSAddressIsZero(&laddr) || mDNSIPPortIsZero(lport) ||
9962         mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(rport) ||
9963         mDNSEthAddressIsZero(eth))
9964     {
9965         return mDNSfalse;
9966     }
9967 
9968     return mDNStrue;
9969 }
9970 
9971 
9972 mDNSlocal void mDNS_ExtractKeepaliveInfo(AuthRecord *ar, mDNSu32 *timeout, mDNSAddr *laddr, mDNSAddr *raddr, mDNSEthAddr *eth, mDNSu32 *seq,
9973                                          mDNSu32 *ack, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu16 *win)
9974 {
9975     if (ar->resrec.rrtype != kDNSType_NULL)
9976         return;
9977 
9978     if (mDNS_KeepaliveRecord(&ar->resrec))
9979     {
9980         int len = ar->resrec.rdlength;
9981         mDNSu8 *ptr = &ar->resrec.rdata->u.txt.c[1];
9982         mDNSu8 *limit = ptr + len - 1; // Exclude the first byte that is the length
9983         mDNSu32 value = 0;
9984 
9985         while (ptr < limit)
9986         {
9987             mDNSu8 param = *ptr;
9988             ptr += 2;   // Skip the letter and the "="
9989             if (param == 'h')
9990             {
9991                 laddr->type = mDNSAddrType_IPv4;
9992                 ptr = GetValueForIPv4Addr(ptr, limit, &laddr->ip.v4);
9993             }
9994             else if (param == 'd')
9995             {
9996                 raddr->type = mDNSAddrType_IPv4;
9997                 ptr = GetValueForIPv4Addr(ptr, limit, &raddr->ip.v4);
9998             }
9999             else if (param == 'H')
10000             {
10001                 laddr->type = mDNSAddrType_IPv6;
10002                 ptr = GetValueForIPv6Addr(ptr, limit, &laddr->ip.v6);
10003             }
10004             else if (param == 'D')
10005             {
10006                 raddr->type = mDNSAddrType_IPv6;
10007                 ptr = GetValueForIPv6Addr(ptr, limit, &raddr->ip.v6);
10008             }
10009             else if (param == 'm')
10010             {
10011                 ptr = GetValueForMACAddr(ptr, limit, eth);
10012             }
10013             else
10014             {
10015                 ptr = GetValueForKeepalive(ptr, limit, &value);
10016             }
10017             if (!ptr) { LogMsg("mDNS_ExtractKeepaliveInfo: Cannot parse\n"); return; }
10018 
10019             // Extract everything in network order so that it is easy for sending a keepalive and also
10020             // for matching incoming TCP packets
10021             switch (param)
10022             {
10023             case 't':
10024                 *timeout = value;
10025                 //if (*timeout < 120) *timeout = 120;
10026                 break;
10027             case 'h':
10028             case 'H':
10029             case 'd':
10030             case 'D':
10031             case 'm':
10032             case 'i':
10033             case 'c':
10034                 break;
10035             case 'l':
10036                 lport->NotAnInteger = swap16((mDNSu16)value);
10037                 break;
10038             case 'r':
10039                 rport->NotAnInteger = swap16((mDNSu16)value);
10040                 break;
10041             case 's':
10042                 *seq = swap32(value);
10043                 break;
10044             case 'a':
10045                 *ack = swap32(value);
10046                 break;
10047             case 'w':
10048                 *win = swap16((mDNSu16)value);
10049                 break;
10050             default:
10051                 LogMsg("mDNS_ExtractKeepaliveInfo: unknown value %c\n", param);
10052                 ptr = limit;
10053                 break;
10054             }
10055             ptr++; // skip the space
10056         }
10057     }
10058 }
10059 
10060 // 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
10061 // the clients need not retrieve this information from the auth record again.
10062 mDNSlocal AuthRecord* mDNS_MatchKeepaliveInfo(mDNS *const m, const mDNSAddr* pladdr, const mDNSAddr* praddr, const mDNSIPPort plport,
10063                                               const mDNSIPPort prport, mDNSu32 *rseq, mDNSu32 *rack)
10064 {
10065     AuthRecord *ar;
10066     mDNSAddr laddr, raddr;
10067     mDNSEthAddr eth;
10068     mDNSIPPort lport, rport;
10069     mDNSu32 timeout, seq, ack;
10070     mDNSu16 win;
10071 
10072     for (ar = m->ResourceRecords; ar; ar=ar->next)
10073     {
10074         timeout = seq = ack = 0;
10075         win = 0;
10076         laddr = raddr = zeroAddr;
10077         lport = rport = zeroIPPort;
10078 
10079         if (!ar->WakeUp.HMAC.l[0]) continue;
10080 
10081         mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10082 
10083         // Did we parse correctly ?
10084         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10085         {
10086             debugf("mDNS_MatchKeepaliveInfo: not a valid record %s for keepalive", ARDisplayString(m, ar));
10087             continue;
10088         }
10089 
10090         debugf("mDNS_MatchKeepaliveInfo: laddr %#a pladdr %#a, raddr %#a praddr %#a, lport %d plport %d, rport %d prport %d",
10091                &laddr, pladdr, &raddr, praddr, mDNSVal16(lport), mDNSVal16(plport), mDNSVal16(rport), mDNSVal16(prport));
10092 
10093         // Does it match the incoming TCP packet ?
10094         if (mDNSSameAddress(&laddr, pladdr) && mDNSSameAddress(&raddr, praddr) && mDNSSameIPPort(lport, plport) && mDNSSameIPPort(rport, prport))
10095         {
10096             // returning in network order
10097             *rseq = seq;
10098             *rack = ack;
10099             return ar;
10100         }
10101     }
10102     return mDNSNULL;
10103 }
10104 
10105 mDNSlocal void mDNS_SendKeepalives(mDNS *const m)
10106 {
10107     AuthRecord *ar;
10108 
10109     for (ar = m->ResourceRecords; ar; ar=ar->next)
10110     {
10111         mDNSu32 timeout, seq, ack;
10112         mDNSu16 win;
10113         mDNSAddr laddr, raddr;
10114         mDNSEthAddr eth;
10115         mDNSIPPort lport, rport;
10116 
10117         timeout = seq = ack = 0;
10118         win = 0;
10119 
10120         laddr = raddr = zeroAddr;
10121         lport = rport = zeroIPPort;
10122 
10123         if (!ar->WakeUp.HMAC.l[0]) continue;
10124 
10125         mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10126 
10127         if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10128         {
10129             debugf("mDNS_SendKeepalives: not a valid record %s for keepalive", ARDisplayString(m, ar));
10130             continue;
10131         }
10132         LogMsg("mDNS_SendKeepalives: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10133 
10134         // When we receive a proxy update, we set KATimeExpire to zero so that we always send a keepalive
10135         // immediately (to detect any potential problems). After that we always set it to a non-zero value.
10136         if (!ar->KATimeExpire || (m->timenow - ar->KATimeExpire >= 0))
10137         {
10138             mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10139             ar->KATimeExpire = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
10140         }
10141         if (m->NextScheduledKA - ar->KATimeExpire > 0)
10142             m->NextScheduledKA = ar->KATimeExpire;
10143     }
10144 }
10145 
10146 mDNSlocal void mDNS_SendKeepaliveACK(mDNS *const m, AuthRecord *ar)
10147 {
10148     mDNSu32     timeout, seq, ack, seqInc;
10149     mDNSu16     win;
10150     mDNSAddr    laddr, raddr;
10151     mDNSEthAddr eth;
10152     mDNSIPPort  lport, rport;
10153     mDNSu8      *ptr;
10154 
10155     if (ar == mDNSNULL)
10156     {
10157         LogInfo("mDNS_SendKeepalivesACK: AuthRecord is NULL");
10158         return;
10159     }
10160 
10161     timeout = seq = ack = 0;
10162     win = 0;
10163 
10164     laddr = raddr = zeroAddr;
10165     lport = rport = zeroIPPort;
10166 
10167     mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10168 
10169     if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10170     {
10171         LogInfo("mDNS_SendKeepaliveACK: not a valid record %s for keepalive", ARDisplayString(m, ar));
10172         return;
10173     }
10174 
10175     // To send a keepalive ACK, we need to add one to the sequence number from the keepalive
10176     // record, which is the TCP connection's "next" sequence number minus one. Otherwise, the
10177     // keepalive ACK also ends up being a keepalive probe. Also, seq is in network byte order, so
10178     // it's converted to host byte order before incrementing it by one.
10179     ptr = (mDNSu8 *)&seq;
10180     seqInc = (mDNSu32)((ptr[0] << 24) | (ptr[1] << 16) | (ptr[2] << 8) | ptr[3]) + 1;
10181     ptr[0] = (mDNSu8)((seqInc >> 24) & 0xFF);
10182     ptr[1] = (mDNSu8)((seqInc >> 16) & 0xFF);
10183     ptr[2] = (mDNSu8)((seqInc >>  8) & 0xFF);
10184     ptr[3] = (mDNSu8)((seqInc      ) & 0xFF);
10185     LogMsg("mDNS_SendKeepaliveACK: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10186     mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10187 }
10188 
10189 mDNSlocal void mDNSCoreReceiveUpdate(mDNS *const m,
10190                                      const DNSMessage *const msg, const mDNSu8 *end,
10191                                      const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
10192                                      const mDNSInterfaceID InterfaceID)
10193 {
10194     int i;
10195     AuthRecord opt;
10196     mDNSu8 *p = m->omsg.data;
10197     OwnerOptData owner = zeroOwner;     // Need to zero this, so we'll know if this Update packet was missing its Owner option
10198     mDNSu32 updatelease = 0;
10199     const mDNSu8 *ptr;
10200 
10201     LogSPS("Received Update from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
10202            "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
10203            srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
10204            msg->h.numQuestions,   msg->h.numQuestions   == 1 ? ", "   : "s,",
10205            msg->h.numAnswers,     msg->h.numAnswers     == 1 ? ", "   : "s,",
10206            msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y,  " : "ies,",
10207            msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " "    : "s", end - msg->data);
10208 
10209     if (!InterfaceID || !m->SPSSocket || !mDNSSameIPPort(dstport, m->SPSSocket->port)) return;
10210 
10211     if (mDNS_PacketLoggingEnabled)
10212         DumpPacket(m, mStatus_NoError, mDNSfalse, "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10213 
10214     ptr = LocateOptRR(msg, end, DNSOpt_LeaseData_Space + DNSOpt_OwnerData_ID_Space);
10215     if (ptr)
10216     {
10217         ptr = GetLargeResourceRecord(m, msg, ptr, end, 0, kDNSRecordTypePacketAdd, &m->rec);
10218         if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
10219         {
10220             const rdataOPT *o;
10221             const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
10222             for (o = &m->rec.r.resrec.rdata->u.opt[0]; o < e; o++)
10223             {
10224                 if      (o->opt == kDNSOpt_Lease) updatelease = o->u.updatelease;
10225                 else if (o->opt == kDNSOpt_Owner && o->u.owner.vers == 0) owner       = o->u.owner;
10226             }
10227         }
10228         m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
10229     }
10230 
10231     InitializeDNSMessage(&m->omsg.h, msg->h.id, UpdateRespFlags);
10232 
10233     if (!updatelease || !owner.HMAC.l[0])
10234     {
10235         static int msgs = 0;
10236         if (msgs < 100)
10237         {
10238             msgs++;
10239             LogMsg("Refusing sleep proxy registration from %#a:%d:%s%s", srcaddr, mDNSVal16(srcport),
10240                    !updatelease ? " No lease" : "", !owner.HMAC.l[0] ? " No owner" : "");
10241         }
10242         m->omsg.h.flags.b[1] |= kDNSFlag1_RC_FormErr;
10243     }
10244     else if (m->ProxyRecords + msg->h.mDNS_numUpdates > MAX_PROXY_RECORDS)
10245     {
10246         static int msgs = 0;
10247         if (msgs < 100)
10248         {
10249             msgs++;
10250             LogMsg("Refusing sleep proxy registration from %#a:%d: Too many records %d + %d = %d > %d", srcaddr, mDNSVal16(srcport),
10251                    m->ProxyRecords, msg->h.mDNS_numUpdates, m->ProxyRecords + msg->h.mDNS_numUpdates, MAX_PROXY_RECORDS);
10252         }
10253         m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10254     }
10255     else
10256     {
10257         LogSPS("Received Update for H-MAC %.6a I-MAC %.6a Password %.6a seq %d", &owner.HMAC, &owner.IMAC, &owner.password, owner.seq);
10258 
10259         if (updatelease > 24 * 60 * 60)
10260             updatelease = 24 * 60 * 60;
10261 
10262         if (updatelease > 0x40000000UL / mDNSPlatformOneSecond)
10263             updatelease = 0x40000000UL / mDNSPlatformOneSecond;
10264 
10265         ptr = LocateAuthorities(msg, end);
10266 
10267         // Clear any stale TCP keepalive records that may exist
10268         ClearKeepaliveProxyRecords(m, &owner, m->DuplicateRecords, InterfaceID);
10269         ClearKeepaliveProxyRecords(m, &owner, m->ResourceRecords, InterfaceID);
10270 
10271         for (i = 0; i < msg->h.mDNS_numUpdates && ptr && ptr < end; i++)
10272         {
10273             ptr = GetLargeResourceRecord(m, msg, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
10274             if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
10275             {
10276                 mDNSu16 RDLengthMem = GetRDLengthMem(&m->rec.r.resrec);
10277                 AuthRecord *ar = mDNSPlatformMemAllocate(sizeof(AuthRecord) - sizeof(RDataBody) + RDLengthMem);
10278                 if (!ar)
10279                 {
10280                     m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10281                     break;
10282                 }
10283                 else
10284                 {
10285                     mDNSu8 RecordType = m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask ? kDNSRecordTypeUnique : kDNSRecordTypeShared;
10286                     m->rec.r.resrec.rrclass &= ~kDNSClass_UniqueRRSet;
10287                     // All stale keepalive records have been flushed prior to this loop.
10288                     if (!mDNS_KeepaliveRecord(&m->rec.r.resrec))
10289                     {
10290                         ClearIdenticalProxyRecords(m, &owner, m->DuplicateRecords); // Make sure we don't have any old stale duplicates of this record
10291                         ClearIdenticalProxyRecords(m, &owner, m->ResourceRecords);
10292                     }
10293                     mDNS_SetupResourceRecord(ar, mDNSNULL, InterfaceID, m->rec.r.resrec.rrtype, m->rec.r.resrec.rroriginalttl, RecordType, AuthRecordAny, SPSRecordCallback, ar);
10294                     AssignDomainName(&ar->namestorage, m->rec.r.resrec.name);
10295                     ar->resrec.rdlength = GetRDLength(&m->rec.r.resrec, mDNSfalse);
10296                     ar->resrec.rdata->MaxRDLength = RDLengthMem;
10297                     mDNSPlatformMemCopy(ar->resrec.rdata->u.data, m->rec.r.resrec.rdata->u.data, RDLengthMem);
10298                     ar->ForceMCast = mDNStrue;
10299                     ar->WakeUp     = owner;
10300                     if (m->rec.r.resrec.rrtype == kDNSType_PTR)
10301                     {
10302                         mDNSs32 t = ReverseMapDomainType(m->rec.r.resrec.name);
10303                         if      (t == mDNSAddrType_IPv4) GetIPv4FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10304                         else if (t == mDNSAddrType_IPv6) GetIPv6FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10305                         debugf("mDNSCoreReceiveUpdate: PTR %d %d %#a %s", t, ar->AddressProxy.type, &ar->AddressProxy, ARDisplayString(m, ar));
10306                         if (ar->AddressProxy.type) SetSPSProxyListChanged(InterfaceID);
10307                     }
10308                     ar->TimeRcvd   = m->timenow;
10309                     ar->TimeExpire = m->timenow + updatelease * mDNSPlatformOneSecond;
10310                     if (m->NextScheduledSPS - ar->TimeExpire > 0)
10311                         m->NextScheduledSPS = ar->TimeExpire;
10312                     ar->KATimeExpire = 0;
10313                     mDNS_Register_internal(m, ar);
10314 
10315                     m->ProxyRecords++;
10316                     mDNS_UpdateAllowSleep(m);
10317                     LogSPS("SPS Registered %4d %X %s", m->ProxyRecords, RecordType, ARDisplayString(m,ar));
10318                 }
10319             }
10320             m->rec.r.resrec.RecordType = 0;     // Clear RecordType to show we're not still using it
10321         }
10322 
10323         if (m->omsg.h.flags.b[1] & kDNSFlag1_RC_Mask)
10324         {
10325             LogMsg("Refusing sleep proxy registration from %#a:%d: Out of memory", srcaddr, mDNSVal16(srcport));
10326             ClearProxyRecords(m, &owner, m->DuplicateRecords);
10327             ClearProxyRecords(m, &owner, m->ResourceRecords);
10328         }
10329         else
10330         {
10331             mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10332             opt.resrec.rrclass    = NormalMaxDNSMessageData;
10333             opt.resrec.rdlength   = sizeof(rdataOPT);   // One option in this OPT record
10334             opt.resrec.rdestimate = sizeof(rdataOPT);
10335             opt.resrec.rdata->u.opt[0].opt           = kDNSOpt_Lease;
10336             opt.resrec.rdata->u.opt[0].u.updatelease = updatelease;
10337             p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
10338         }
10339     }
10340 
10341     if (p) mDNSSendDNSMessage(m, &m->omsg, p, InterfaceID, m->SPSSocket, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
10342     mDNS_SendKeepalives(m);
10343 }
10344 
10345 mDNSlocal mDNSu32 mDNSGenerateOwnerOptForInterface(mDNS *const m, const mDNSInterfaceID InterfaceID, DNSMessage *msg)
10346 {
10347     mDNSu8 *ptr    = msg->data;
10348     mDNSu8 *end    = mDNSNULL;
10349     mDNSu32 length = 0;
10350     AuthRecord opt;
10351     NetworkInterfaceInfo *intf;
10352 
10353     mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10354     opt.resrec.rrclass    = NormalMaxDNSMessageData;
10355     opt.resrec.rdlength   = sizeof(rdataOPT);
10356     opt.resrec.rdestimate = sizeof(rdataOPT);
10357 
10358     intf = FirstInterfaceForID(m, InterfaceID);
10359     SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
10360 
10361     LogSPS("Generated OPT record : %s", ARDisplayString(m, &opt));
10362     end = PutResourceRecord(msg, ptr, &msg->h.numAdditionals, &opt.resrec);
10363     if (end != mDNSNULL)
10364     {
10365         // Put all the integer values in IETF byte-order (MSB first, LSB second)
10366         SwapDNSHeaderBytes(msg);
10367         length = (end - msg->data);
10368     }
10369     else
10370         LogSPS("mDNSGenerateOwnerOptForInterface: Failed to generate owner OPT record");
10371 
10372     return length;
10373 }
10374 
10375 // Note that this routine is called both for Sleep Proxy Registrations, and for Standard Dynamic
10376 // DNS registrations, but (currently) only has to handle the Sleep Proxy Registration reply case,
10377 // and should ignore Standard Dynamic DNS registration replies, because those are handled elsewhere.
10378 // Really, both should be unified and handled in one place.
10379 mDNSlocal void mDNSCoreReceiveUpdateR(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *end, const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID)
10380 {
10381     if (InterfaceID)
10382     {
10383         mDNSu32 pktlease = 0, spsupdates = 0;
10384         const mDNSBool gotlease = GetPktLease(m, msg, end, &pktlease);
10385         const mDNSu32 updatelease = gotlease ? pktlease : 60 * 60; // If SPS fails to indicate lease time, assume one hour
10386         if (gotlease) LogSPS("DNS Update response contains lease option granting %4d seconds, updateid %d, InterfaceID %p", updatelease, mDNSVal16(msg->h.id), InterfaceID);
10387 
10388         if (m->CurrentRecord)
10389             LogMsg("mDNSCoreReceiveUpdateR ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
10390         m->CurrentRecord = m->ResourceRecords;
10391         while (m->CurrentRecord)
10392         {
10393             AuthRecord *const rr = m->CurrentRecord;
10394             if (rr->resrec.InterfaceID == InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
10395                 if (mDNSSameOpaque16(rr->updateid, msg->h.id))
10396                 {
10397                     // We successfully completed this record's registration on this "InterfaceID". Clear that bit.
10398                     // Clear the updateid when we are done sending on all interfaces.
10399                     mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, InterfaceID, mDNStrue);
10400                     if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
10401                         bit_clr_opaque64(rr->updateIntID, scopeid);
10402                     if (mDNSOpaque64IsZero(&rr->updateIntID))
10403                         rr->updateid = zeroID;
10404                     rr->expire   = NonZeroTime(m->timenow + updatelease * mDNSPlatformOneSecond);
10405                     spsupdates++;
10406                     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));
10407                     if (rr->WakeUp.HMAC.l[0])
10408                     {
10409                         rr->WakeUp.HMAC = zeroEthAddr;  // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
10410                         rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it
10411                         mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
10412                     }
10413                 }
10414             // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
10415             // new records could have been added to the end of the list as a result of that call.
10416             if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
10417                 m->CurrentRecord = rr->next;
10418         }
10419         if (spsupdates) // Only do this dynamic store stuff if this was, in fact, a Sleep Proxy Update response
10420         {
10421             char *ifname;
10422             mDNSAddr spsaddr;
10423             DNSMessage optMsg;
10424             int length;
10425             // Update the dynamic store with the IP Address and MAC address of the sleep proxy
10426             ifname = InterfaceNameForID(m, InterfaceID);
10427             mDNSPlatformMemCopy(&spsaddr, srcaddr, sizeof (mDNSAddr));
10428             mDNSPlatformStoreSPSMACAddr(&spsaddr, ifname);
10429 
10430             // Store the Owner OPT record for this interface.
10431             // Configd may use the OPT record if it detects a conflict with the BSP when the system wakes up
10432             InitializeDNSMessage(&optMsg.h, zeroID, ResponseFlags);
10433             length = mDNSGenerateOwnerOptForInterface(m, InterfaceID, &optMsg);
10434             if (length != 0)
10435             {
10436                 length += sizeof(DNSMessageHeader);
10437                 mDNSPlatformStoreOwnerOptRecord(ifname, &optMsg, length);
10438             }
10439         }
10440     }
10441     // If we were waiting to go to sleep, then this SPS registration or wide-area record deletion
10442     // may have been the thing we were waiting for, so schedule another check to see if we can sleep now.
10443     if (m->SleepLimit) m->NextScheduledSPRetry = m->timenow;
10444 }
10445 
10446 mDNSexport void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr,
10447                                         const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds, mDNSInterfaceID InterfaceID, DNSServer *dnsserver)
10448 {
10449     if (cr == &m->rec.r && m->rec.r.resrec.RecordType)
10450         LogFatalError("MakeNegativeCacheRecord: m->rec appears to be already in use for %s", CRDisplayString(m, &m->rec.r));
10451 
10452     // Create empty resource record
10453     cr->resrec.RecordType    = kDNSRecordTypePacketNegative;
10454     cr->resrec.InterfaceID   = InterfaceID;
10455     cr->resrec.rDNSServer    = dnsserver;
10456     cr->resrec.name          = name;    // Will be updated to point to cg->name when we call CreateNewCacheEntry
10457     cr->resrec.rrtype        = rrtype;
10458     cr->resrec.rrclass       = rrclass;
10459     cr->resrec.rroriginalttl = ttl_seconds;
10460     cr->resrec.rdlength      = 0;
10461     cr->resrec.rdestimate    = 0;
10462     cr->resrec.namehash      = namehash;
10463     cr->resrec.rdatahash     = 0;
10464     cr->resrec.rdata = (RData*)&cr->smallrdatastorage;
10465     cr->resrec.rdata->MaxRDLength = 0;
10466 
10467     cr->NextInKAList       = mDNSNULL;
10468     cr->TimeRcvd           = m->timenow;
10469     cr->DelayDelivery      = 0;
10470     cr->NextRequiredQuery  = m->timenow;
10471     cr->LastUsed           = m->timenow;
10472     cr->CRActiveQuestion   = mDNSNULL;
10473     cr->UnansweredQueries  = 0;
10474     cr->LastUnansweredTime = 0;
10475     cr->NextInCFList       = mDNSNULL;
10476     cr->nsec               = mDNSNULL;
10477     cr->soa                = mDNSNULL;
10478     cr->CRDNSSECQuestion   = 0;
10479     // Initialize to the basic one and the caller can set it to more
10480     // specific based on the response if any
10481     cr->responseFlags      = ResponseFlags;
10482 }
10483 
10484 mDNSexport void mDNSCoreReceive(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end,
10485                                 const mDNSAddr *const srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, const mDNSIPPort dstport,
10486                                 const mDNSInterfaceID InterfaceID)
10487 {
10488     mDNSInterfaceID ifid = InterfaceID;
10489     const mDNSu8 *const pkt = (mDNSu8 *)msg;
10490     const mDNSu8 StdQ = kDNSFlag0_QR_Query    | kDNSFlag0_OP_StdQuery;
10491     const mDNSu8 StdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_StdQuery;
10492     const mDNSu8 UpdQ = kDNSFlag0_QR_Query    | kDNSFlag0_OP_Update;
10493     const mDNSu8 UpdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_Update;
10494     mDNSu8 QR_OP;
10495     mDNSu8 *ptr = mDNSNULL;
10496     mDNSBool TLS = (dstaddr == (mDNSAddr *)1);  // For debug logs: dstaddr = 0 means TCP; dstaddr = 1 means TLS
10497     if (TLS) dstaddr = mDNSNULL;
10498 
10499 #ifndef UNICAST_DISABLED
10500     if (mDNSSameAddress(srcaddr, &m->Router))
10501     {
10502 #ifdef _LEGACY_NAT_TRAVERSAL_
10503         if (mDNSSameIPPort(srcport, SSDPPort) || (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)))
10504         {
10505             mDNS_Lock(m);
10506             LNT_ConfigureRouterInfo(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10507             mDNS_Unlock(m);
10508             return;
10509         }
10510 #endif
10511         if (mDNSSameIPPort(srcport, NATPMPPort))
10512         {
10513             mDNS_Lock(m);
10514             uDNS_ReceiveNATPacket(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10515             mDNS_Unlock(m);
10516             return;
10517         }
10518     }
10519 #ifdef _LEGACY_NAT_TRAVERSAL_
10520     else if (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)) { debugf("Ignoring SSDP response from %#a:%d", srcaddr, mDNSVal16(srcport)); return; }
10521 #endif
10522 
10523 #endif
10524     if ((unsigned)(end - pkt) < sizeof(DNSMessageHeader))
10525     {
10526         LogMsg("DNS Message from %#a:%d to %#a:%d length %d too short", srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt));
10527         return;
10528     }
10529     QR_OP = (mDNSu8)(msg->h.flags.b[0] & kDNSFlag0_QROP_Mask);
10530     // Read the integer parts which are in IETF byte-order (MSB first, LSB second)
10531     ptr = (mDNSu8 *)&msg->h.numQuestions;
10532     msg->h.numQuestions   = (mDNSu16)((mDNSu16)ptr[0] << 8 | ptr[1]);
10533     msg->h.numAnswers     = (mDNSu16)((mDNSu16)ptr[2] << 8 | ptr[3]);
10534     msg->h.numAuthorities = (mDNSu16)((mDNSu16)ptr[4] << 8 | ptr[5]);
10535     msg->h.numAdditionals = (mDNSu16)((mDNSu16)ptr[6] << 8 | ptr[7]);
10536 
10537     if (!m) { LogMsg("mDNSCoreReceive ERROR m is NULL"); return; }
10538 
10539     // We use zero addresses and all-ones addresses at various places in the code to indicate special values like "no address"
10540     // If we accept and try to process a packet with zero or all-ones source address, that could really mess things up
10541     if (srcaddr && !mDNSAddressIsValid(srcaddr)) { debugf("mDNSCoreReceive ignoring packet from %#a", srcaddr); return; }
10542 
10543     mDNS_Lock(m);
10544     m->PktNum++;
10545     if (mDNSOpaque16IsZero(msg->h.id))
10546     {
10547         m->MPktNum++;
10548 #if APPLE_OSX_mDNSResponder
10549         // Track the number of multicast packets received from a source outside our subnet.
10550         // Check the destination address to avoid accounting for spurious packets that
10551         // comes in with message id zero.
10552         if (!mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr) && dstaddr &&
10553             mDNSAddressIsAllDNSLinkGroup(dstaddr))
10554         {
10555             m->RemoteSubnet++;
10556         }
10557 #endif // #if APPLE_OSX_mDNSResponder
10558     }
10559 
10560 #ifndef UNICAST_DISABLED
10561     if (!dstaddr || (!mDNSAddressIsAllDNSLinkGroup(dstaddr) && (QR_OP == StdR || QR_OP == UpdR)))
10562         if (!mDNSOpaque16IsZero(msg->h.id)) // uDNS_ReceiveMsg only needs to get real uDNS responses, not "QU" mDNS responses
10563         {
10564             ifid = mDNSInterface_Any;
10565             if (mDNS_PacketLoggingEnabled)
10566                 DumpPacket(m, mStatus_NoError, mDNSfalse, TLS ? "TLS" : !dstaddr ? "TCP" : "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10567             uDNS_ReceiveMsg(m, msg, end, srcaddr, srcport);
10568             // Note: mDNSCore also needs to get access to received unicast responses
10569         }
10570 #endif
10571     if      (QR_OP == StdQ) mDNSCoreReceiveQuery   (m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10572     else if (QR_OP == StdR) mDNSCoreReceiveResponse(m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10573     else if (QR_OP == UpdQ) mDNSCoreReceiveUpdate  (m, msg, end, srcaddr, srcport, dstaddr, dstport, InterfaceID);
10574     else if (QR_OP == UpdR) mDNSCoreReceiveUpdateR (m, msg, end, srcaddr,                            InterfaceID);
10575     else
10576     {
10577         if (mDNS_LoggingEnabled)
10578         {
10579             static int msgCount = 0;
10580             if (msgCount < 1000) {
10581                 int i = 0;
10582                 msgCount++;
10583                 LogInfo("Unknown DNS packet type %02X%02X from %#-15a:%-5d to %#-15a:%-5d length %d on %p (ignored)",
10584                         msg->h.flags.b[0], msg->h.flags.b[1], srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt), InterfaceID);
10585                 while (i < (int)(end - pkt))
10586                 {
10587                     char buffer[128];
10588                     char *p = buffer + mDNS_snprintf(buffer, sizeof(buffer), "%04X", i);
10589                     do if (i < (int)(end - pkt)) p += mDNS_snprintf(p, sizeof(buffer), " %02X", pkt[i]);while (++i & 15);
10590                     LogInfo("%s", buffer);
10591                 }
10592             }
10593         }
10594     }
10595     // Packet reception often causes a change to the task list:
10596     // 1. Inbound queries can cause us to need to send responses
10597     // 2. Conflicing response packets received from other hosts can cause us to need to send defensive responses
10598     // 3. Other hosts announcing deletion of shared records can cause us to need to re-assert those records
10599     // 4. Response packets that answer questions may cause our client to issue new questions
10600     mDNS_Unlock(m);
10601 }
10602 
10603 // ***************************************************************************
10604 #if COMPILER_LIKES_PRAGMA_MARK
10605 #pragma mark -
10606 #pragma mark - Searcher Functions
10607 #endif
10608 
10609 // Targets are considered the same if both queries are untargeted, or
10610 // if both are targeted to the same address+port
10611 // (If Target address is zero, TargetPort is undefined)
10612 #define SameQTarget(A,B) (((A)->Target.type == mDNSAddrType_None && (B)->Target.type == mDNSAddrType_None) || \
10613                           (mDNSSameAddress(& (A)->Target, & (B)->Target) && mDNSSameIPPort((A)->TargetPort, (B)->TargetPort)))
10614 
10615 // SameQuestionKind is true if *both* questions are either multicast or unicast
10616 // TargetQID is used for this determination.
10617 #define SameQuestionKind(A,B) ((mDNSOpaque16IsZero(A) && mDNSOpaque16IsZero(B)) || \
10618                                ((!mDNSOpaque16IsZero(A)) && (!mDNSOpaque16IsZero(B))))
10619 
10620 // Note: We explicitly disallow making a public query be a duplicate of a private one. This is to avoid the
10621 // circular deadlock where a client does a query for something like "dns-sd -Q _dns-query-tls._tcp.company.com SRV"
10622 // and we have a key for company.com, so we try to locate the private query server for company.com, which necessarily entails
10623 // doing a standard DNS query for the _dns-query-tls._tcp SRV record for company.com. If we make the latter (public) query
10624 // a duplicate of the former (private) query, then it will block forever waiting for an answer that will never come.
10625 //
10626 // We keep SuppressUnusable questions separate so that we can return a quick response to them and not get blocked behind
10627 // the queries that are not marked SuppressUnusable. But if the query is not suppressed, they are treated the same as
10628 // non-SuppressUnusable questions. This should be fine as the goal of SuppressUnusable is to return quickly only if it
10629 // is suppressed. If it is not suppressed, we do try all the DNS servers for valid answers like any other question.
10630 // The main reason for this design is that cache entries point to a *single* question and that question is responsible
10631 // for keeping the cache fresh as long as it is active. Having multiple active question for a single cache entry
10632 // breaks this design principle.
10633 //
10634 
10635 // If IsLLQ(Q) is true, it means the question is both:
10636 // (a) long-lived and
10637 // (b) being performed by a unicast DNS long-lived query (either full LLQ, or polling)
10638 // for multicast questions, we don't want to treat LongLived as anything special
10639 #define IsLLQ(Q) ((Q)->LongLived && !mDNSOpaque16IsZero((Q)->TargetQID))
10640 #define IsAWDLIncluded(Q) (((Q)->flags & kDNSServiceFlagsIncludeAWDL) != 0)
10641 
10642 mDNSlocal DNSQuestion *FindDuplicateQuestion(const mDNS *const m, const DNSQuestion *const question)
10643 {
10644     DNSQuestion *q;
10645     // Note: A question can only be marked as a duplicate of one that occurs *earlier* in the list.
10646     // This prevents circular references, where two questions are each marked as a duplicate of the other.
10647     // Accordingly, we break out of the loop when we get to 'question', because there's no point searching
10648     // further in the list.
10649     for (q = m->Questions; q && q != question; q=q->next)       // Scan our list for another question
10650         if (q->InterfaceID == question->InterfaceID &&          // with the same InterfaceID,
10651             SameQTarget(q, question)                &&          // and same unicast/multicast target settings
10652             q->qtype      == question->qtype        &&          // type,
10653             q->qclass     == question->qclass       &&          // class,
10654             IsLLQ(q)      == IsLLQ(question)        &&          // and long-lived status matches
10655             (!q->AuthInfo || question->AuthInfo)    &&          // to avoid deadlock, don't make public query dup of a private one
10656             (q->AnonInfo  == question->AnonInfo)    &&          // Anonymous query not a dup of normal query
10657             (q->SuppressQuery == question->SuppressQuery) &&    // Questions that are suppressed/not suppressed
10658             (q->ValidationRequired == question->ValidationRequired) &&  // Questions that require DNSSEC validation
10659             (q->ValidatingResponse == question->ValidatingResponse) &&  // Questions that are validating responses using DNSSEC
10660             (q->DisallowPID == question->DisallowPID)     &&            // Disallowing a PID should not affect a PID that is allowed
10661             (q->BrowseThreshold == question->BrowseThreshold) &&  // browse thresholds must match
10662             q->qnamehash  == question->qnamehash    &&
10663             (IsAWDLIncluded(q) == IsAWDLIncluded(question)) &&     // Inclusion of AWDL interface must match
10664             SameQuestionKind(q->TargetQID, question->TargetQID) && // mDNS or uDNS must match
10665             SameDomainName(&q->qname, &question->qname))           // and name
10666             return(q);
10667     return(mDNSNULL);
10668 }
10669 
10670 // This is called after a question is deleted, in case other identical questions were being suppressed as duplicates
10671 mDNSlocal void UpdateQuestionDuplicates(mDNS *const m, DNSQuestion *const question)
10672 {
10673     DNSQuestion *q;
10674     DNSQuestion *first = mDNSNULL;
10675 
10676     // This is referring to some other question as duplicate. No other question can refer to this
10677     // question as a duplicate.
10678     if (question->DuplicateOf)
10679     {
10680         LogInfo("UpdateQuestionDuplicates: question %p %##s (%s) duplicate of %p %##s (%s)",
10681                 question, question->qname.c, DNSTypeName(question->qtype),
10682                 question->DuplicateOf, question->DuplicateOf->qname.c, DNSTypeName(question->DuplicateOf->qtype));
10683         return;
10684     }
10685 
10686     for (q = m->Questions; q; q=q->next)        // Scan our list of questions
10687         if (q->DuplicateOf == question)         // To see if any questions were referencing this as their duplicate
10688         {
10689             q->DuplicateOf = first;
10690             if (!first)
10691             {
10692                 first = q;
10693                 // If q used to be a duplicate, but now is not,
10694                 // then inherit the state from the question that's going away
10695                 q->LastQTime         = question->LastQTime;
10696                 q->ThisQInterval     = question->ThisQInterval;
10697                 q->ExpectUnicastResp = question->ExpectUnicastResp;
10698                 q->LastAnswerPktNum  = question->LastAnswerPktNum;
10699                 q->RecentAnswerPkts  = question->RecentAnswerPkts;
10700                 q->RequestUnicast    = question->RequestUnicast;
10701                 q->LastQTxTime       = question->LastQTxTime;
10702                 q->CNAMEReferrals    = question->CNAMEReferrals;
10703                 q->nta               = question->nta;
10704                 q->servAddr          = question->servAddr;
10705                 q->servPort          = question->servPort;
10706                 q->qDNSServer        = question->qDNSServer;
10707                 q->validDNSServers   = question->validDNSServers;
10708                 q->unansweredQueries = question->unansweredQueries;
10709                 q->noServerResponse  = question->noServerResponse;
10710                 q->triedAllServersOnce = question->triedAllServersOnce;
10711 
10712                 q->TargetQID         = question->TargetQID;
10713                 q->LocalSocket       = question->LocalSocket;
10714                 // No need to close old q->LocalSocket first -- duplicate questions can't have their own sockets
10715 
10716                 q->state             = question->state;
10717                 //  q->tcp               = question->tcp;
10718                 q->ReqLease          = question->ReqLease;
10719                 q->expire            = question->expire;
10720                 q->ntries            = question->ntries;
10721                 q->id                = question->id;
10722 
10723                 question->LocalSocket = mDNSNULL;
10724                 question->nta        = mDNSNULL;    // If we've got a GetZoneData in progress, transfer it to the newly active question
10725                 //  question->tcp        = mDNSNULL;
10726 
10727                 if (q->LocalSocket)
10728                     debugf("UpdateQuestionDuplicates transferred LocalSocket pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10729 
10730                 if (q->nta)
10731                 {
10732                     LogInfo("UpdateQuestionDuplicates transferred nta pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10733                     q->nta->ZoneDataContext = q;
10734                 }
10735 
10736                 // Need to work out how to safely transfer this state too -- appropriate context pointers need to be updated or the code will crash
10737                 if (question->tcp) LogInfo("UpdateQuestionDuplicates did not transfer tcp pointer");
10738 
10739                 if (question->state == LLQ_Established)
10740                 {
10741                     LogInfo("UpdateQuestionDuplicates transferred LLQ state for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10742                     question->state = 0;    // Must zero question->state, or mDNS_StopQuery_internal will clean up and cancel our LLQ from the server
10743                 }
10744 
10745                 SetNextQueryTime(m,q);
10746             }
10747         }
10748 }
10749 
10750 mDNSexport McastResolver *mDNS_AddMcastResolver(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSu32 timeout)
10751 {
10752     McastResolver **p = &m->McastResolvers;
10753     McastResolver *tmp = mDNSNULL;
10754 
10755     if (!d) d = (const domainname *)"";
10756 
10757     LogInfo("mDNS_AddMcastResolver: Adding %##s, InterfaceID %p, timeout %u", d->c, interface, timeout);
10758 
10759     mDNS_CheckLock(m);
10760 
10761     while (*p)  // Check if we already have this {interface, domain} tuple registered
10762     {
10763         if ((*p)->interface == interface && SameDomainName(&(*p)->domain, d))
10764         {
10765             if (!((*p)->flags & McastResolver_FlagDelete)) LogMsg("Note: Mcast Resolver domain %##s (%p) registered more than once", d->c, interface);
10766             (*p)->flags &= ~McastResolver_FlagDelete;
10767             tmp = *p;
10768             *p = tmp->next;
10769             tmp->next = mDNSNULL;
10770         }
10771         else
10772             p=&(*p)->next;
10773     }
10774 
10775     if (tmp) *p = tmp; // move to end of list, to ensure ordering from platform layer
10776     else
10777     {
10778         // allocate, add to list
10779         *p = mDNSPlatformMemAllocate(sizeof(**p));
10780         if (!*p) LogMsg("mDNS_AddMcastResolver: ERROR!! - malloc");
10781         else
10782         {
10783             (*p)->interface = interface;
10784             (*p)->flags     = McastResolver_FlagNew;
10785             (*p)->timeout   = timeout;
10786             AssignDomainName(&(*p)->domain, d);
10787             (*p)->next = mDNSNULL;
10788         }
10789     }
10790     return(*p);
10791 }
10792 
10793 mDNSinline mDNSs32 PenaltyTimeForServer(mDNS *m, DNSServer *server)
10794 {
10795     mDNSs32 ptime = 0;
10796     if (server->penaltyTime != 0)
10797     {
10798         ptime = server->penaltyTime - m->timenow;
10799         if (ptime < 0)
10800         {
10801             // This should always be a positive value between 0 and DNSSERVER_PENALTY_TIME
10802             // If it does not get reset in ResetDNSServerPenalties for some reason, we do it
10803             // here
10804             LogMsg("PenaltyTimeForServer: PenaltyTime negative %d, (server penaltyTime %d, timenow %d) resetting the penalty",
10805                    ptime, server->penaltyTime, m->timenow);
10806             server->penaltyTime = 0;
10807             ptime = 0;
10808         }
10809     }
10810     return ptime;
10811 }
10812 
10813 //Checks to see whether the newname is a better match for the name, given the best one we have
10814 //seen so far (given in bestcount).
10815 //Returns -1 if the newname is not a better match
10816 //Returns 0 if the newname is the same as the old match
10817 //Returns 1 if the newname is a better match
10818 mDNSlocal int BetterMatchForName(const domainname *name, int namecount, const domainname *newname, int newcount,
10819                                  int bestcount)
10820 {
10821     // If the name contains fewer labels than the new server's domain or the new name
10822     // contains fewer labels than the current best, then it can't possibly be a better match
10823     if (namecount < newcount || newcount < bestcount) return -1;
10824 
10825     // If there is no match, return -1 and the caller will skip this newname for
10826     // selection
10827     //
10828     // If we find a match and the number of labels is the same as bestcount, then
10829     // we return 0 so that the caller can do additional logic to pick one of
10830     // the best based on some other factors e.g., penaltyTime
10831     //
10832     // If we find a match and the number of labels is more than bestcount, then we
10833     // return 1 so that the caller can pick this over the old one.
10834     //
10835     // Note: newcount can either be equal or greater than bestcount beause of the
10836     // check above.
10837 
10838     if (SameDomainName(SkipLeadingLabels(name, namecount - newcount), newname))
10839         return bestcount == newcount ? 0 : 1;
10840     else
10841         return -1;
10842 }
10843 
10844 // Normally, we have McastResolvers for .local, in-addr.arpa and ip6.arpa. But there
10845 // can be queries that can forced to multicast (ForceMCast) even though they don't end in these
10846 // names. In that case, we give a default timeout of 5 seconds
10847 #define DEFAULT_MCAST_TIMEOUT   5
10848 mDNSlocal mDNSu32 GetTimeoutForMcastQuestion(mDNS *m, DNSQuestion *question)
10849 {
10850     McastResolver *curmatch = mDNSNULL;
10851     int bestmatchlen = -1, namecount = CountLabels(&question->qname);
10852     McastResolver *curr;
10853     int bettermatch, currcount;
10854     for (curr = m->McastResolvers; curr; curr = curr->next)
10855     {
10856         currcount = CountLabels(&curr->domain);
10857         bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
10858         // Take the first best match. If there are multiple equally good matches (bettermatch = 0), we take
10859         // the timeout value from the first one
10860         if (bettermatch == 1)
10861         {
10862             curmatch = curr;
10863             bestmatchlen = currcount;
10864         }
10865     }
10866     LogInfo("GetTimeoutForMcastQuestion: question %##s curmatch %p, Timeout %d", question->qname.c, curmatch,
10867             curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10868     return ( curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10869 }
10870 
10871 // Returns true if it is a Domain Enumeration Query
10872 mDNSexport mDNSBool DomainEnumQuery(const domainname *qname)
10873 {
10874     const mDNSu8 *mDNS_DEQLabels[] = { (const mDNSu8 *)"\001b", (const mDNSu8 *)"\002db", (const mDNSu8 *)"\002lb",
10875                                        (const mDNSu8 *)"\001r", (const mDNSu8 *)"\002dr", (const mDNSu8 *)mDNSNULL, };
10876     const domainname *d = qname;
10877     const mDNSu8 *label;
10878     int i = 0;
10879 
10880     // We need at least 3 labels (DEQ prefix) + one more label to make a meaningful DE query
10881     if (CountLabels(qname) < 4) { debugf("DomainEnumQuery: question %##s, not enough labels", qname->c); return mDNSfalse; }
10882 
10883     label = (const mDNSu8 *)d;
10884     while (mDNS_DEQLabels[i] != (const mDNSu8 *)mDNSNULL)
10885     {
10886         if (SameDomainLabel(mDNS_DEQLabels[i], label)) {debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c); break;}
10887         i++;
10888     }
10889     if (mDNS_DEQLabels[i] == (const mDNSu8 *)mDNSNULL)
10890     {
10891         debugf("DomainEnumQuery: Not a DEQ %##s, label1 mismatch", qname->c);
10892         return mDNSfalse;
10893     }
10894     debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c);
10895 
10896     // CountLabels already verified the number of labels
10897     d = (const domainname *)(d->c + 1 + d->c[0]);   // Second Label
10898     label = (const mDNSu8 *)d;
10899     if (!SameDomainLabel(label, (const mDNSu8 *)"\007_dns-sd"))
10900     {
10901         debugf("DomainEnumQuery: Not a DEQ %##s, label2 mismatch", qname->c);
10902         return(mDNSfalse);
10903     }
10904     debugf("DomainEnumQuery: DEQ %##s, label2 match", qname->c);
10905 
10906     d = (const domainname *)(d->c + 1 + d->c[0]);   // Third Label
10907     label = (const mDNSu8 *)d;
10908     if (!SameDomainLabel(label, (const mDNSu8 *)"\004_udp"))
10909     {
10910         debugf("DomainEnumQuery: Not a DEQ %##s, label3 mismatch", qname->c);
10911         return(mDNSfalse);
10912     }
10913     debugf("DomainEnumQuery: DEQ %##s, label3 match", qname->c);
10914 
10915     debugf("DomainEnumQuery: Question %##s is a Domain Enumeration query", qname->c);
10916 
10917     return mDNStrue;
10918 }
10919 
10920 // Note: InterfaceID is the InterfaceID of the question
10921 mDNSlocal mDNSBool DNSServerMatch(DNSServer *d, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
10922 {
10923     // 1) Unscoped questions (NULL InterfaceID) should  consider *only* unscoped DNSServers ( DNSServer
10924     // with "scoped" set to kScopeNone)
10925     //
10926     // 2) Scoped questions (non-NULL InterfaceID) should consider *only* scoped DNSServers (DNSServer
10927     // with "scoped" set to kScopeInterfaceId) and their InterfaceIDs should match.
10928     //
10929     // 3) Scoped questions (non-zero ServiceID) should consider *only* scoped DNSServers (DNSServer
10930     // with "scoped" set to kScopeServiceID) and their ServiceIDs should match.
10931     //
10932     // The first condition in the "if" statement checks to see if both the question and the DNSServer are
10933     // unscoped. The question is unscoped only if InterfaceID is zero and ServiceID is -1.
10934     //
10935     // If the first condition fails, following are the possible cases (the notes below are using
10936     // InterfaceID for discussion and the same holds good for ServiceID):
10937     //
10938     // - DNSServer is not scoped, InterfaceID is not NULL - we should skip the current DNSServer entry
10939     //   as scoped questions should not pick non-scoped DNSServer entry (Refer to (2) above).
10940     //
10941     // - DNSServer is scoped, InterfaceID is NULL - we should skip the current DNSServer entry as
10942     //   unscoped question should not match scoped DNSServer (Refer to (1) above). The InterfaceID check
10943     //   would fail in this case.
10944     //
10945     // - DNSServer is scoped and InterfaceID is not NULL - the InterfaceID of the question and the DNSServer
10946     //   should match (Refer to (2) above).
10947     //
10948     // Note: mDNSInterface_Unicast is used only by .local unicast questions and are treated as unscoped.
10949     // If a question is scoped both to InterfaceID and ServiceID, the question will be scoped to InterfaceID.
10950 
10951     if (((d->scoped == kScopeNone) && ((!InterfaceID && ServiceID == -1) || InterfaceID == mDNSInterface_Unicast)) ||
10952         ((d->scoped == kScopeInterfaceID) && d->interface == InterfaceID) ||
10953         ((d->scoped == kScopeServiceID) && d->serviceID == ServiceID))
10954     {
10955         return mDNStrue;
10956     }
10957     return mDNSfalse;
10958 }
10959 
10960 // Sets all the Valid DNS servers for a question
10961 mDNSexport mDNSu32 SetValidDNSServers(mDNS *m, DNSQuestion *question)
10962 {
10963     int bestmatchlen = -1, namecount = CountLabels(&question->qname);
10964     DNSServer *curr;
10965     int bettermatch, currcount;
10966     int index = 0;
10967     mDNSu32 timeout = 0;
10968     mDNSBool DEQuery;
10969 
10970     question->validDNSServers = zeroOpaque128;
10971     DEQuery = DomainEnumQuery(&question->qname);
10972     for (curr = m->DNSServers; curr; curr = curr->next)
10973     {
10974         debugf("SetValidDNSServers: Parsing DNS server Address %#a (Domain %##s), Scope: %d", &curr->addr, curr->domain.c, curr->scoped);
10975         // skip servers that will soon be deleted
10976         if (curr->flags & DNSServer_FlagDelete)
10977         {
10978             debugf("SetValidDNSServers: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
10979             continue;
10980         }
10981 
10982         // This happens normally when you unplug the interface where we reset the interfaceID to mDNSInterface_Any for all
10983         // the DNS servers whose scope match the interfaceID. Few seconds later, we also receive the updated DNS configuration.
10984         // But any questions that has mDNSInterface_Any scope that are started/restarted before we receive the update
10985         // (e.g., CheckSuppressUnusableQuestions is called when interfaces are deregistered with the core) should not
10986         // match the scoped entries by mistake.
10987         //
10988         // Note: DNS configuration change will help pick the new dns servers but currently it does not affect the timeout
10989 
10990         // Skip DNSServers that are InterfaceID Scoped but have no valid interfaceid set OR DNSServers that are ServiceID Scoped but have no valid serviceid set
10991         if ((curr->scoped == kScopeInterfaceID && curr->interface == mDNSInterface_Any) || (curr->scoped == kScopeServiceID && curr->serviceID <= 0))
10992         {
10993             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);
10994             continue;
10995         }
10996 
10997         currcount = CountLabels(&curr->domain);
10998         if ((!curr->cellIntf || (!DEQuery && !(question->flags & kDNSServiceFlagsDenyCellular))) &&
10999             (!curr->isExpensive || !(question->flags & kDNSServiceFlagsDenyExpensive)) &&
11000             DNSServerMatch(curr, question->InterfaceID, question->ServiceID))
11001         {
11002             bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
11003 
11004             // If we found a better match (bettermatch == 1) then clear all the bits
11005             // corresponding to the old DNSServers that we have may set before and start fresh.
11006             // If we find an equal match, then include that DNSServer also by setting the corresponding
11007             // bit
11008             if ((bettermatch == 1) || (bettermatch == 0))
11009             {
11010                 bestmatchlen = currcount;
11011                 if (bettermatch)
11012                 {
11013                     debugf("SetValidDNSServers: Resetting all the bits");
11014                     question->validDNSServers = zeroOpaque128;
11015                     timeout = 0;
11016                 }
11017                 debugf("SetValidDNSServers: question %##s Setting the bit for DNS server Address %#a (Domain %##s), Scoped:%d index %d,"
11018                        " Timeout %d, interface %p", question->qname.c, &curr->addr, curr->domain.c, curr->scoped, index, curr->timeout,
11019                        curr->interface);
11020                 timeout += curr->timeout;
11021                 if (DEQuery)
11022                     debugf("DomainEnumQuery: Question %##s, DNSServer %#a, cell %d", question->qname.c, &curr->addr, curr->cellIntf);
11023                 bit_set_opaque128(question->validDNSServers, index);
11024             }
11025         }
11026         index++;
11027     }
11028     question->noServerResponse = 0;
11029 
11030     debugf("SetValidDNSServers: ValidDNSServer bits  0x%x%x%x%x for question %p %##s (%s)",
11031            question->validDNSServers.l[3], question->validDNSServers.l[2], question->validDNSServers.l[1], question->validDNSServers.l[0], question, question->qname.c, DNSTypeName(question->qtype));
11032     // If there are no matching resolvers, then use the default timeout value.
11033     // For ProxyQuestion, shorten the timeout so that dig does not timeout on us in case of no response.
11034     return ((question->ProxyQuestion || question->ValidatingResponse) ? DEFAULT_UDNSSEC_TIMEOUT : timeout ? timeout : DEFAULT_UDNS_TIMEOUT);
11035 }
11036 
11037 // Get the Best server that matches a name. If you find penalized servers, look for the one
11038 // that will come out of the penalty box soon
11039 mDNSlocal DNSServer *GetBestServer(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID, mDNSOpaque128 validBits,
11040     int *selected, mDNSBool nameMatch)
11041 {
11042     DNSServer *curmatch = mDNSNULL;
11043     int bestmatchlen = -1, namecount = name ? CountLabels(name) : 0;
11044     DNSServer *curr;
11045     mDNSs32 bestPenaltyTime, currPenaltyTime;
11046     int bettermatch, currcount;
11047     int index = 0;
11048     int currindex = -1;
11049 
11050     debugf("GetBestServer: ValidDNSServer bits  0x%x%x", validBits.l[1], validBits.l[0]);
11051     bestPenaltyTime = DNSSERVER_PENALTY_TIME + 1;
11052     for (curr = m->DNSServers; curr; curr = curr->next)
11053     {
11054         // skip servers that will soon be deleted
11055         if (curr->flags & DNSServer_FlagDelete)
11056         {
11057             debugf("GetBestServer: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
11058             continue;
11059         }
11060 
11061         // Check if this is a valid DNSServer
11062         if (!bit_get_opaque64(validBits, index))
11063         {
11064             debugf("GetBestServer: continuing for index %d", index);
11065             index++;
11066             continue;
11067         }
11068 
11069         currcount = CountLabels(&curr->domain);
11070         currPenaltyTime = PenaltyTimeForServer(m, curr);
11071 
11072         debugf("GetBestServer: Address %#a (Domain %##s), PenaltyTime(abs) %d, PenaltyTime(rel) %d",
11073                &curr->addr, curr->domain.c, curr->penaltyTime, currPenaltyTime);
11074 
11075         // If there are multiple best servers for a given question, we will pick the first one
11076         // if none of them are penalized. If some of them are penalized in that list, we pick
11077         // the least penalized one. BetterMatchForName walks through all best matches and
11078         // "currPenaltyTime < bestPenaltyTime" check lets us either pick the first best server
11079         // in the list when there are no penalized servers and least one among them
11080         // when there are some penalized servers.
11081 
11082         if (DNSServerMatch(curr, InterfaceID, ServiceID))
11083         {
11084 
11085             // If we know that all the names are already equally good matches, then skip calling BetterMatchForName.
11086             // This happens when we initially walk all the DNS servers and set the validity bit on the question.
11087             // Actually we just need PenaltyTime match, but for the sake of readability we just skip the expensive
11088             // part and still do some redundant steps e.g., InterfaceID match
11089 
11090             if (nameMatch)
11091                 bettermatch = BetterMatchForName(name, namecount, &curr->domain, currcount, bestmatchlen);
11092             else
11093                 bettermatch = 0;
11094 
11095             // If we found a better match (bettermatch == 1) then we don't need to
11096             // compare penalty times. But if we found an equal match, then we compare
11097             // the penalty times to pick a better match
11098 
11099             if ((bettermatch == 1) || ((bettermatch == 0) && currPenaltyTime < bestPenaltyTime))
11100             {
11101                 currindex = index;
11102                 curmatch = curr;
11103                 bestmatchlen = currcount;
11104                 bestPenaltyTime = currPenaltyTime;
11105             }
11106         }
11107         index++;
11108     }
11109     if (selected) *selected = currindex;
11110     return curmatch;
11111 }
11112 
11113 // Look up a DNS Server, matching by name and InterfaceID
11114 mDNSlocal DNSServer *GetServerForName(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
11115 {
11116     DNSServer *curmatch = mDNSNULL;
11117     char *ifname = mDNSNULL;    // for logging purposes only
11118     mDNSOpaque128 allValid;
11119 
11120     if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11121         InterfaceID = mDNSNULL;
11122 
11123     if (InterfaceID) ifname = InterfaceNameForID(m, InterfaceID);
11124 
11125     // By passing in all ones, we make sure that every DNS server is considered
11126     allValid.l[0] = allValid.l[1] = allValid.l[2] = allValid.l[3] = 0xFFFFFFFF;
11127 
11128     curmatch = GetBestServer(m, name, InterfaceID, ServiceID, allValid, mDNSNULL, mDNStrue);
11129 
11130     if (curmatch != mDNSNULL)
11131         LogInfo("GetServerForName: DNS server %#a:%d (Penalty Time Left %d) (Scope %s:%p) found for name %##s", &curmatch->addr,
11132                 mDNSVal16(curmatch->port), (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11133                 InterfaceID, name);
11134     else
11135         LogInfo("GetServerForName: no DNS server (Scope %s:%p) found for name %##s", ifname ? ifname : "None", InterfaceID, name);
11136 
11137     return(curmatch);
11138 }
11139 
11140 // Look up a DNS Server for a question within its valid DNSServer bits
11141 mDNSexport DNSServer *GetServerForQuestion(mDNS *m, DNSQuestion *question)
11142 {
11143     DNSServer *curmatch = mDNSNULL;
11144     char *ifname = mDNSNULL;    // for logging purposes only
11145     mDNSInterfaceID InterfaceID = question->InterfaceID;
11146     const domainname *name = &question->qname;
11147     int currindex;
11148 
11149     if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11150         InterfaceID = mDNSNULL;
11151 
11152     if (InterfaceID)
11153         ifname = InterfaceNameForID(m, InterfaceID);
11154 
11155     if (!mDNSOpaque128IsZero(&question->validDNSServers))
11156     {
11157         curmatch = GetBestServer(m, name, InterfaceID, question->ServiceID, question->validDNSServers, &currindex, mDNSfalse);
11158         if (currindex != -1)
11159             bit_clr_opaque128(question->validDNSServers, currindex);
11160     }
11161 
11162     if (curmatch != mDNSNULL)
11163     {
11164         LogInfo("GetServerForQuestion: %p DNS server (%p) %#a:%d (Penalty Time Left %d) (Scope %s:%p:%d) found for name %##s (%s)",
11165                 question, curmatch, &curmatch->addr, mDNSVal16(curmatch->port),
11166                 (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11167                 InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11168     }
11169     else
11170     {
11171         LogInfo("GetServerForQuestion: %p no DNS server (Scope %s:%p:%d) found for name %##s (%s)",
11172             question, ifname ? ifname : "None", InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11173     }
11174 
11175     return(curmatch);
11176 }
11177 
11178 
11179 #define ValidQuestionTarget(Q) (((Q)->Target.type == mDNSAddrType_IPv4 || (Q)->Target.type == mDNSAddrType_IPv6) && \
11180                                 (mDNSSameIPPort((Q)->TargetPort, UnicastDNSPort) || mDNSSameIPPort((Q)->TargetPort, MulticastDNSPort)))
11181 
11182 // Called in normal client context (lock not held)
11183 mDNSlocal void LLQNATCallback(mDNS *m, NATTraversalInfo *n)
11184 {
11185     DNSQuestion *q;
11186     mDNS_Lock(m);
11187     LogInfo("LLQNATCallback external address:port %.4a:%u, NAT result %d", &n->ExternalAddress, mDNSVal16(n->ExternalPort), n->Result);
11188     n->clientContext = mDNSNULL; // we received at least one callback since starting this NAT-T
11189     for (q = m->Questions; q; q=q->next)
11190         if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived)
11191             startLLQHandshake(m, q);    // If ExternalPort is zero, will do StartLLQPolling instead
11192 #if APPLE_OSX_mDNSResponder
11193     UpdateAutoTunnelDomainStatuses(m);
11194 #endif
11195     mDNS_Unlock(m);
11196 }
11197 
11198 mDNSlocal mDNSBool IsPrivateDomain(mDNS *const m, DNSQuestion *q)
11199 {
11200     DomainAuthInfo *AuthInfo;
11201     // Skip Private domains as we have special addresses to get the hosts in the Private domain
11202     AuthInfo = GetAuthInfoForName_internal(m, &q->qname);
11203     if (AuthInfo && !AuthInfo->deltime && AuthInfo->AutoTunnel)
11204     {
11205         debugf("IsPrivateDomain: %##s true", q->qname.c);
11206         return mDNStrue;
11207     }
11208     else
11209     {
11210         debugf("IsPrivateDomain: %##s false", q->qname.c);
11211         return mDNSfalse;
11212     }
11213 }
11214 
11215 // This function takes the DNSServer as a separate argument because sometimes the
11216 // caller has not yet assigned the DNSServer, but wants to evaluate the SuppressQuery
11217 // status before switching to it.
11218 mDNSlocal mDNSBool ShouldSuppressUnicastQuery(mDNS *const m, DNSQuestion *q, DNSServer *d)
11219 {
11220     // Some callers don't check for the qtype
11221     if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11222     {
11223         LogInfo("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11224         return mDNSfalse;
11225     }
11226 
11227     // Private domains are exempted irrespective of what the DNSServer says
11228     if (IsPrivateDomain(m, q))
11229     {
11230         LogInfo("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, Private Domain", q->qname.c, DNSTypeName(q->qtype));
11231         return mDNSfalse;
11232     }
11233 
11234     if (!d)
11235     {
11236         LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, as the DNS server is NULL", q->qname.c, DNSTypeName(q->qtype));
11237         return mDNStrue;
11238     }
11239 
11240     // Check if the DNS Configuration allows A/AAAA queries to be sent
11241     if ((q->qtype == kDNSType_A) && (d->req_A))
11242     {
11243         LogInfo("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows A queries", q->qname.c,
11244                 DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11245         return mDNSfalse;
11246     }
11247     if ((q->qtype == kDNSType_AAAA) && (d->req_AAAA))
11248     {
11249         LogInfo("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows AAAA queries", q->qname.c,
11250                 DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11251         return mDNSfalse;
11252     }
11253 #if USE_DNS64
11254     if (DNS64IsQueryingARecord(q->dns64.state))
11255     {
11256         LogInfo("ShouldSuppressUnicastQuery: DNS64 query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11257         return mDNSfalse;
11258     }
11259 #endif
11260 
11261     LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, since DNS Configuration does not allow (req_A is %s and req_AAAA is %s)",
11262         q->qname.c, DNSTypeName(q->qtype), d->req_A ? "true" : "false", d->req_AAAA ? "true" : "false");
11263 
11264     return mDNStrue;
11265 }
11266 
11267 mDNSlocal mDNSBool ShouldSuppressDotLocalQuery(mDNS *const m, DNSQuestion *q)
11268 {
11269     NetworkInterfaceInfo *intf;
11270     AuthRecord *rr;
11271     mDNSBool ret;
11272 
11273     // Check to see if there is at least one interface other than loopback and don't suppress
11274     // .local questions if you find one. If we have at least one interface, it means that
11275     // we can send unicast queries for the .local name and we don't want to suppress
11276     // multicast in that case as upper layers don't know how to handle if we return a
11277     // negative response for multicast followed by a positive response for unicast.
11278     //
11279     // Note: we used to check for multicast capable interfaces instead of just any interface
11280     // present. That did not work in the case where we have a valid interface for unicast
11281     // but not multicast capable e.g., cellular, as we ended up delivering a negative response
11282     // first and the upper layer did not wait for the positive response that came later.
11283     for (intf = m->HostInterfaces; intf; intf = intf->next)
11284     {
11285         if (intf->InterfaceActive && !intf->Loopback)
11286         {
11287             LogInfo("ShouldSuppressDotLocalQuery: Found interface %s, not suppressing", intf->ifname);
11288             return mDNSfalse;
11289         }
11290     }
11291 
11292     // 1. If we find a LocalOnly or P2P record answering this question, then don't suppress it.
11293     //    Set m->CurrentQuestion as it is required by AnswerQuestionWithLORecord.
11294     m->CurrentQuestion = q;
11295     ret = AnswerQuestionWithLORecord(m, q, mDNStrue);
11296     m->CurrentQuestion = mDNSNULL;
11297 
11298     if (ret)
11299     {
11300         LogInfo("ShouldSuppressDotLocalQuery: Found LocalOnly record for %##s (%s), not suppressing", q->qname.c,
11301             DNSTypeName(q->qtype));
11302         return mDNSfalse;
11303     }
11304 
11305     // 2. If we find a local AuthRecord answering this question, then don't suppress it.
11306     for (rr = m->ResourceRecords; rr; rr = rr->next)
11307     {
11308         if (ResourceRecordAnswersQuestion(&rr->resrec, q))
11309         {
11310             LogInfo("ShouldSuppressDotLocalQuery: Found resource record %s for %##s (%s) not suppressing", ARDisplayString(m, rr),
11311                 q->qname.c, DNSTypeName(q->qtype));
11312             return mDNSfalse;
11313         }
11314     }
11315     return mDNStrue;
11316 }
11317 
11318 mDNSlocal mDNSBool ShouldSuppressQuery(mDNS *const m, DNSQuestion *q)
11319 {
11320     if (q->InterfaceID == mDNSInterface_LocalOnly)
11321     {
11322         LogInfo("ShouldSuppressQuery: LocalOnly query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11323         return mDNSfalse;
11324     }
11325 
11326     if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11327     {
11328         LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11329         return mDNSfalse;
11330     }
11331 
11332     // We still want the ability to be able to listen to the local services and hence
11333     // don't fail .local query if we have local records that can potentially answer
11334     // the question.
11335     if (q->InterfaceID != mDNSInterface_Unicast && IsLocalDomain(&q->qname))
11336     {
11337         if (!ShouldSuppressDotLocalQuery(m, q))
11338         {
11339             LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11340             return mDNSfalse;
11341         }
11342         else
11343         {
11344             LogInfo("ShouldSuppressQuery: Query suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11345             return mDNStrue;
11346         }
11347     }
11348 
11349     return (ShouldSuppressUnicastQuery(m, q, q->qDNSServer));
11350 }
11351 
11352 mDNSlocal void CacheRecordRmvEventsForCurrentQuestion(mDNS *const m, DNSQuestion *q)
11353 {
11354     CacheRecord *rr;
11355     CacheGroup *cg;
11356 
11357     cg = CacheGroupForName(m, q->qnamehash, &q->qname);
11358     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
11359     {
11360         // Don't deliver RMV events for negative records
11361         if (rr->resrec.RecordType == kDNSRecordTypePacketNegative)
11362         {
11363             LogInfo("CacheRecordRmvEventsForCurrentQuestion: CacheRecord %s Suppressing RMV events for question %p %##s (%s), CRActiveQuestion %p, CurrentAnswers %d",
11364                     CRDisplayString(m, rr), q, q->qname.c, DNSTypeName(q->qtype), rr->CRActiveQuestion, q->CurrentAnswers);
11365             continue;
11366         }
11367 
11368         if (SameNameRecordAnswersQuestion(&rr->resrec, q))
11369         {
11370             LogInfo("CacheRecordRmvEventsForCurrentQuestion: Calling AnswerCurrentQuestionWithResourceRecord (RMV) for question %##s using resource record %s LocalAnswers %d",
11371                     q->qname.c, CRDisplayString(m, rr), q->LOAddressAnswers);
11372 
11373             q->CurrentAnswers--;
11374             if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
11375             if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
11376 
11377             if (rr->CRActiveQuestion == q)
11378             {
11379                 DNSQuestion *qptr;
11380                 // If this was the active question for this cache entry, it was the one that was
11381                 // responsible for keeping the cache entry fresh when the cache entry was reaching
11382                 // its expiry. We need to handover the responsibility to someone else. Otherwise,
11383                 // when the cache entry is about to expire, we won't find an active question
11384                 // (pointed by CRActiveQuestion) to refresh the cache.
11385                 for (qptr = m->Questions; qptr; qptr=qptr->next)
11386                     if (qptr != q && ActiveQuestion(qptr) && ResourceRecordAnswersQuestion(&rr->resrec, qptr))
11387                         break;
11388 
11389                 if (qptr)
11390                     LogInfo("CacheRecordRmvEventsForCurrentQuestion: Updating CRActiveQuestion to %p for cache record %s, "
11391                             "Original question CurrentAnswers %d, new question CurrentAnswers %d, SuppressUnusable %d, SuppressQuery %d",
11392                             qptr, CRDisplayString(m,rr), q->CurrentAnswers, qptr->CurrentAnswers, qptr->SuppressUnusable, qptr->SuppressQuery);
11393 
11394                 rr->CRActiveQuestion = qptr;        // Question used to be active; new value may or may not be null
11395                 if (!qptr) m->rrcache_active--; // If no longer active, decrement rrcache_active count
11396             }
11397             AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
11398             if (m->CurrentQuestion != q) break;     // If callback deleted q, then we're finished here
11399         }
11400     }
11401 }
11402 
11403 mDNSlocal mDNSBool IsQuestionNew(mDNS *const m, DNSQuestion *question)
11404 {
11405     DNSQuestion *q;
11406     for (q = m->NewQuestions; q; q = q->next)
11407         if (q == question) return mDNStrue;
11408     return mDNSfalse;
11409 }
11410 
11411 mDNSlocal mDNSBool LocalRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11412 {
11413     AuthRecord *rr;
11414     AuthGroup *ag;
11415 
11416     if (m->CurrentQuestion)
11417         LogMsg("LocalRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11418                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11419 
11420     if (IsQuestionNew(m, q))
11421     {
11422         LogInfo("LocalRecordRmvEventsForQuestion: New Question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11423         return mDNStrue;
11424     }
11425     m->CurrentQuestion = q;
11426     ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
11427     if (ag)
11428     {
11429         for (rr = ag->members; rr; rr=rr->next)
11430             // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
11431             if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
11432             {
11433                 LogInfo("LocalRecordRmvEventsForQuestion: Delivering possible Rmv events with record %s",
11434                         ARDisplayString(m, rr));
11435                 if (q->CurrentAnswers <= 0 || q->LOAddressAnswers <= 0)
11436                 {
11437                     LogMsg("LocalRecordRmvEventsForQuestion: ERROR!! CurrentAnswers or LOAddressAnswers is zero %p %##s"
11438                            " (%s) CurrentAnswers %d, LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype),
11439                            q->CurrentAnswers, q->LOAddressAnswers);
11440                     continue;
11441                 }
11442                 AnswerLocalQuestionWithLocalAuthRecord(m, rr, QC_rmv);      // MUST NOT dereference q again
11443                 if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11444             }
11445     }
11446     m->CurrentQuestion = mDNSNULL;
11447     return mDNStrue;
11448 }
11449 
11450 // Returns false if the question got deleted while delivering the RMV events
11451 // The caller should handle the case
11452 mDNSexport mDNSBool CacheRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11453 {
11454     if (m->CurrentQuestion)
11455         LogMsg("CacheRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11456                m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11457 
11458     // If it is a new question, we have not delivered any ADD events yet. So, don't deliver RMV events.
11459     // If this question was answered using local auth records, then you can't deliver RMVs using cache
11460     if (!IsQuestionNew(m, q) && !q->LOAddressAnswers)
11461     {
11462         m->CurrentQuestion = q;
11463         CacheRecordRmvEventsForCurrentQuestion(m, q);
11464         if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11465         m->CurrentQuestion = mDNSNULL;
11466     }
11467     else { LogInfo("CacheRecordRmvEventsForQuestion: Question %p %##s (%s) is a new question", q, q->qname.c, DNSTypeName(q->qtype)); }
11468     return mDNStrue;
11469 }
11470 
11471 mDNSlocal void SuppressStatusChanged(mDNS *const m, DNSQuestion *q, DNSQuestion **restart)
11472 {
11473     // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
11474     // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
11475     // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers)
11476     if (q->SuppressQuery)
11477     {
11478         q->SuppressQuery = mDNSfalse;
11479         if (!CacheRecordRmvEventsForQuestion(m, q))
11480         {
11481             LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from cache");
11482             return;
11483         }
11484         q->SuppressQuery = mDNStrue;
11485     }
11486 
11487     // SuppressUnusable does not affect questions that are answered from the local records (/etc/hosts)
11488     // and SuppressQuery status does not mean anything for these questions. As we are going to stop the
11489     // question below, we need to deliver the RMV events so that the ADDs that will be delivered during
11490     // the restart will not be a duplicate ADD
11491     if (!LocalRecordRmvEventsForQuestion(m, q))
11492     {
11493         LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from Local AuthRecords");
11494         return;
11495     }
11496 
11497     // There are two cases here.
11498     //
11499     // 1. Previously it was suppressed and now it is not suppressed, restart the question so
11500     // that it will start as a new question. Note that we can't just call ActivateUnicastQuery
11501     // because when we get the response, if we had entries in the cache already, it will not answer
11502     // this question if the cache entry did not change. Hence, we need to restart
11503     // the query so that it can be answered from the cache.
11504     //
11505     // 2. Previously it was not suppressed and now it is suppressed. We need to restart the questions
11506     // so that we redo the duplicate checks in mDNS_StartQuery_internal. A SuppressUnusable question
11507     // is a duplicate of non-SuppressUnusable question if it is not suppressed (SuppressQuery is false).
11508     // A SuppressUnusable question is not a duplicate of non-SuppressUnusable question if it is suppressed
11509     // (SuppressQuery is true). The reason for this is that when a question is suppressed, we want an
11510     // immediate response and not want to be blocked behind a question that is querying DNS servers. When
11511     // the question is not suppressed, we don't want two active questions sending packets on the wire.
11512     // This affects both efficiency and also the current design where there is only one active question
11513     // pointed to from a cache entry.
11514     //
11515     // We restart queries in a two step process by first calling stop and build a temporary list which we
11516     // will restart at the end. The main reason for the two step process is to handle duplicate questions.
11517     // If there are duplicate questions, calling stop inherits the values from another question on the list (which
11518     // will soon become the real question) including q->ThisQInterval which might be zero if it was
11519     // suppressed before. At the end when we have restarted all questions, none of them is active as each
11520     // inherits from one another and we need to reactivate one of the questions here which is a little hacky.
11521     //
11522     // It is much cleaner and less error prone to build a list of questions and restart at the end.
11523 
11524     LogInfo("SuppressStatusChanged: Stop question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11525     mDNS_StopQuery_internal(m, q);
11526     q->next = *restart;
11527     *restart = q;
11528 }
11529 
11530 // The caller should hold the lock
11531 mDNSexport void CheckSuppressUnusableQuestions(mDNS *const m)
11532 {
11533     DNSQuestion *q;
11534     DNSQuestion *restart = mDNSNULL;
11535 
11536     // We look through all questions including new questions. During network change events,
11537     // we potentially restart questions here in this function that ends up as new questions,
11538     // which may be suppressed at this instance. Before it is handled we get another network
11539     // event that changes the status e.g., address becomes available. If we did not process
11540     // new questions, we would never change its SuppressQuery status.
11541     //
11542     // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
11543     // application callback can potentially stop the current question (detected by CurrentQuestion) or
11544     // *any* other question which could be the next one that we may process here. RestartQuestion
11545     // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
11546     // if the "next" question is stopped while the CurrentQuestion is stopped
11547     if (m->RestartQuestion)
11548         LogMsg("CheckSuppressUnusableQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11549                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11550     m->RestartQuestion = m->Questions;
11551     while (m->RestartQuestion)
11552     {
11553         q = m->RestartQuestion;
11554         m->RestartQuestion = q->next;
11555         if (q->SuppressUnusable)
11556         {
11557             mDNSBool old = q->SuppressQuery;
11558             q->SuppressQuery = ShouldSuppressQuery(m, q);
11559             if (q->SuppressQuery != old)
11560             {
11561                 // Previously it was not suppressed, Generate RMV events for the ADDs that we might have delivered before
11562                 // followed by a negative cache response. Temporarily turn off suppression so that
11563                 // AnswerCurrentQuestionWithResourceRecord can answer the question
11564                 SuppressStatusChanged(m, q, &restart);
11565             }
11566         }
11567     }
11568     while (restart)
11569     {
11570         q = restart;
11571         restart = restart->next;
11572         q->next = mDNSNULL;
11573         LogInfo("CheckSuppressUnusableQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11574         mDNS_StartQuery_internal(m, q);
11575     }
11576 }
11577 
11578 mDNSlocal void RestartUnicastQuestions(mDNS *const m)
11579 {
11580     DNSQuestion *q;
11581     DNSQuestion *restart = mDNSNULL;
11582 
11583     if (m->RestartQuestion)
11584         LogMsg("RestartUnicastQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11585                m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11586     m->RestartQuestion = m->Questions;
11587     while (m->RestartQuestion)
11588     {
11589         q = m->RestartQuestion;
11590         m->RestartQuestion = q->next;
11591         if (q->Restart)
11592         {
11593             if (mDNSOpaque16IsZero(q->TargetQID))
11594                 LogMsg("RestartUnicastQuestions: ERROR!! Restart set for multicast question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11595 
11596             q->Restart = 0;
11597             SuppressStatusChanged(m, q, &restart);
11598         }
11599     }
11600     while (restart)
11601     {
11602         q = restart;
11603         restart = restart->next;
11604         q->next = mDNSNULL;
11605         LogInfo("RestartUnicastQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11606         mDNS_StartQuery_internal(m, q);
11607     }
11608 }
11609 
11610 
11611 // ValidateParameters() is called by mDNS_StartQuery_internal() to check the client parameters of
11612 // DNS Question that are already set by the client before calling mDNS_StartQuery()
11613 mDNSlocal mStatus ValidateParameters(mDNS *const m, DNSQuestion *const question)
11614 {
11615 
11616     if (question->Target.type && !ValidQuestionTarget(question))
11617     {
11618         LogMsg("ValidateParameters: Warning! Target.type = %ld port = %u (Client forgot to initialize before calling mDNS_StartQuery? for question %##s)",
11619                question->Target.type, mDNSVal16(question->TargetPort), question->qname.c);
11620         question->Target.type = mDNSAddrType_None;
11621     }
11622 
11623     // If no question->Target specified, clear TargetPort
11624     if (!question->Target.type)
11625         question->TargetPort = zeroIPPort;
11626 
11627     if (!ValidateDomainName(&question->qname))
11628     {
11629         LogMsg("ValidateParameters: Attempt to start query with invalid qname %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
11630         return(mStatus_Invalid);
11631     }
11632 
11633     // If this question is referencing a specific interface, verify it exists
11634     if (question->InterfaceID && !LocalOnlyOrP2PInterface(question->InterfaceID) && question->InterfaceID != mDNSInterface_Unicast)
11635     {
11636         NetworkInterfaceInfo *intf = FirstInterfaceForID(m, question->InterfaceID);
11637         if (!intf)
11638             LogInfo("ValidateParameters: Note: InterfaceID %d for question %##s (%s) not currently found in active interface list",
11639                     (uint32_t)question->InterfaceID, question->qname.c, DNSTypeName(question->qtype));
11640     }
11641 
11642     return(mStatus_NoError);
11643 }
11644 
11645 // InitDNSConfig() is called by InitCommonState() to initialize the DNS configuration of the Question.
11646 // These are a subset of the internal uDNS fields. Must be done before ShouldSuppressQuery() & mDNS_PurgeForQuestion()
11647 mDNSlocal void InitDNSConfig(mDNS *const m, DNSQuestion *const question)
11648 {
11649     // First reset all DNS Configuration
11650     question->qDNSServer          = mDNSNULL;
11651     question->validDNSServers     = zeroOpaque128;
11652     question->triedAllServersOnce = 0;
11653     question->noServerResponse    = 0;
11654     question->StopTime            = (question->TimeoutQuestion) ? question->StopTime : 0;
11655 #if AWD_METRICS
11656     mDNSPlatformMemZero(&question->metrics, sizeof(question->metrics));
11657 #endif
11658 
11659     // Need not initialize the DNS Configuration for Local Only OR P2P Questions when timeout not specified
11660     if (LocalOnlyOrP2PInterface(question->InterfaceID) && !question->TimeoutQuestion)
11661         return;
11662     // Proceed to initialize DNS Configuration (some are set in SetValidDNSServers())
11663     if (!mDNSOpaque16IsZero(question->TargetQID))
11664     {
11665         mDNSu32 timeout = SetValidDNSServers(m, question);
11666         // We set the timeout value the first time mDNS_StartQuery_internal is called for a question.
11667         // So if a question is restarted when a network change occurs, the StopTime is not reset.
11668         // Note that we set the timeout for all questions. If this turns out to be a duplicate,
11669         // it gets a full timeout value even if the original question times out earlier.
11670         if (question->TimeoutQuestion && !question->StopTime)
11671         {
11672             question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11673             LogInfo("InitDNSConfig: Setting StopTime on the uDNS question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11674         }
11675 
11676         question->qDNSServer = GetServerForQuestion(m, question);
11677         LogInfo("InitDNSConfig: question %p %##s (%s) Timeout %d, DNS Server %#a:%d",
11678                  question, question->qname.c, DNSTypeName(question->qtype), timeout,
11679                  question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
11680                  mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
11681     }
11682     else if (question->TimeoutQuestion && !question->StopTime)
11683     {
11684         // If the question is to be timed out and its a multicast, local-only or P2P case,
11685         // then set it's stop time.
11686         mDNSu32 timeout = LocalOnlyOrP2PInterface(question->InterfaceID) ?
11687                             DEFAULT_LO_OR_P2P_TIMEOUT : GetTimeoutForMcastQuestion(m, question);
11688         question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11689         LogInfo("InitDNSConfig: Setting StopTime on question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11690     }
11691     // Set StopTime here since it is a part of DNS Configuration
11692     if (question->StopTime)
11693         SetNextQueryStopTime(m, question);
11694     // Don't call SetNextQueryTime() if a LocalOnly OR P2P Question since those questions
11695     // will never be transmitted on the wire.
11696     if (!(LocalOnlyOrP2PInterface(question->InterfaceID)))
11697         SetNextQueryTime(m,question);
11698 }
11699 
11700 // InitCommonState() is called by mDNS_StartQuery_internal() to initialize the common(uDNS/mDNS) internal
11701 // state fields of the DNS Question. These are independent of the Client layer.
11702 mDNSlocal mDNSBool InitCommonState(mDNS *const m, DNSQuestion *const question)
11703 {
11704     mDNSBool purge;
11705     int i;
11706     mDNSBool isBlocked = mDNSfalse;
11707 
11708     // Note: In the case where we already have the answer to this question in our cache, that may be all the client
11709     // wanted, and they may immediately cancel their question. In this case, sending an actual query on the wire would
11710     // be a waste. For that reason, we schedule our first query to go out in half a second (InitialQuestionInterval).
11711     // If AnswerNewQuestion() finds that we have *no* relevant answers currently in our cache, then it will accelerate
11712     // that to go out immediately.
11713     question->next              = mDNSNULL;
11714     // ThisQInterval should be initialized before any memory allocations occur. If malloc
11715     // debugging is turned on within mDNSResponder (see mDNSDebug.h for details) it validates
11716     // the question list to check if ThisQInterval is negative which means the question has been
11717     // stopped and can't be on the list. The question is already on the list and ThisQInterval
11718     // can be negative if the caller just stopped it and starting it again. Hence, it always has to
11719     // be initialized. CheckForSoonToExpireRecords below prints the cache records when logging is
11720     // turned ON which can allocate memory e.g., base64 encoding, in the case of DNSSEC.
11721     question->ThisQInterval     = InitialQuestionInterval;                  // MUST be > zero for an active question
11722     question->qnamehash         = DomainNameHashValue(&question->qname);
11723     question->DelayAnswering    = CheckForSoonToExpireRecords(m, &question->qname, question->qnamehash, &purge);
11724     question->LastQTime         = m->timenow;
11725     question->ExpectUnicastResp = 0;
11726     question->LastAnswerPktNum  = m->PktNum;
11727     question->RecentAnswerPkts  = 0;
11728     question->CurrentAnswers    = 0;
11729 
11730 #if APPLE_OSX_mDNSResponder
11731 
11732 // Initial browse threshold used by Finder.
11733 #define mDNSFinderBrowseThreshold 20
11734 
11735     // Set the threshold at which we move to a passive browse state,
11736     // not actively sending queries.
11737     if (question->flags & kDNSServiceFlagsThresholdOne)
11738         question->BrowseThreshold   = 1;
11739     else if (question->flags & kDNSServiceFlagsThresholdFinder)
11740         question->BrowseThreshold   = mDNSFinderBrowseThreshold;
11741     else
11742         question->BrowseThreshold   = 0;
11743 
11744 #else   // APPLE_OSX_mDNSResponder
11745    question->BrowseThreshold   = 0;
11746 #endif  // APPLE_OSX_mDNSResponder
11747     question->CachedAnswerNeedsUpdate = mDNSfalse;
11748 
11749     question->LargeAnswers      = 0;
11750     question->UniqueAnswers     = 0;
11751     question->LOAddressAnswers  = 0;
11752     question->FlappingInterface1 = mDNSNULL;
11753     question->FlappingInterface2 = mDNSNULL;
11754 
11755     // if kDNSServiceFlagsServiceIndex flag is SET by the client, then do NOT call mDNSPlatformGetDNSRoutePolicy()
11756     // since we would already have the question->ServiceID in that case.
11757     if (!(question->flags & kDNSServiceFlagsServiceIndex))
11758     {
11759 #if APPLE_OSX_mDNSResponder
11760         mDNSPlatformGetDNSRoutePolicy(question, &isBlocked);
11761 #else
11762         question->ServiceID = -1;
11763 #endif
11764     }
11765     else
11766         LogInfo("InitCommonState: Query for %##s (%s), PID[%d], EUID[%d], ServiceID[%d] is already set by client", question->qname.c,
11767                 DNSTypeName(question->qtype), question->pid, question->euid, question->ServiceID);
11768 
11769     InitDNSConfig(m, question);
11770 
11771     question->AuthInfo          = GetAuthInfoForQuestion(m, question);
11772     question->SuppressQuery     = 0;
11773     if (question->SuppressUnusable)
11774         question->SuppressQuery = ShouldSuppressQuery(m, question);
11775 
11776     // If ServiceID is 0 or the policy disallows making DNS requests,
11777     // set DisallowPID
11778     question->DisallowPID       = (question->ServiceID == 0 || isBlocked);
11779     if (question->DisallowPID)
11780         LogInfo("InitCommonState: Query suppressed for %##s (%s), PID %d/ServiceID %d not allowed", question->qname.c,
11781             DNSTypeName(question->qtype), question->pid, question->ServiceID);
11782 
11783     question->NextInDQList      = mDNSNULL;
11784     question->SendQNow          = mDNSNULL;
11785     question->SendOnAll         = mDNSfalse;
11786     question->RequestUnicast    = kDefaultRequestUnicastCount;
11787 
11788 #if APPLE_OSX_mDNSResponder
11789     // Set the QU bit in the first query for the following options.
11790     if ((question->flags & kDNSServiceFlagsUnicastResponse) || (question->flags & kDNSServiceFlagsThresholdFinder))
11791     {
11792         question->RequestUnicast    = SET_QU_IN_FIRST_QUERY;
11793         LogInfo("InitCommonState: setting RequestUnicast = %d for %##s (%s)", question->RequestUnicast, question->qname.c,
11794             DNSTypeName(question->qtype));
11795     }
11796 #endif  // APPLE_OSX_mDNSResponder
11797 
11798     question->LastQTxTime       = m->timenow;
11799     question->CNAMEReferrals    = 0;
11800 
11801     question->WakeOnResolveCount = 0;
11802     if (question->WakeOnResolve)
11803     {
11804         question->WakeOnResolveCount = InitialWakeOnResolveCount;
11805         purge = mDNStrue;
11806     }
11807 
11808     for (i=0; i<DupSuppressInfoSize; i++)
11809         question->DupSuppress[i].InterfaceID = mDNSNULL;
11810 
11811     question->Restart = 0;
11812 
11813     debugf("InitCommonState: Question %##s (%s) Interface %p Now %d Send in %d Answer in %d (%p) %s (%p)",
11814             question->qname.c, DNSTypeName(question->qtype), question->InterfaceID, m->timenow,
11815             NextQSendTime(question) - m->timenow,
11816             question->DelayAnswering ? question->DelayAnswering - m->timenow : 0,
11817             question, question->DuplicateOf ? "duplicate of" : "not duplicate", question->DuplicateOf);
11818 
11819     if (question->DelayAnswering)
11820         LogInfo("InitCommonState: Delaying answering for %d ticks while cache stabilizes for %##s (%s)",
11821                  question->DelayAnswering - m->timenow, question->qname.c, DNSTypeName(question->qtype));
11822 
11823     return(purge);
11824 }
11825 
11826 // Excludes the DNS Config fields which are already handled by InitDNSConfig()
11827 mDNSlocal void InitWABState(DNSQuestion *const question)
11828 {
11829     // We'll create our question->LocalSocket on demand, if needed.
11830     // We won't need one for duplicate questions, or from questions answered immediately out of the cache.
11831     // We also don't need one for LLQs because (when we're using NAT) we want them all to share a single
11832     // NAT mapping for receiving inbound add/remove events.
11833     question->LocalSocket       = mDNSNULL;
11834     question->unansweredQueries = 0;
11835     question->nta               = mDNSNULL;
11836     question->servAddr          = zeroAddr;
11837     question->servPort          = zeroIPPort;
11838     question->tcp               = mDNSNULL;
11839     question->NoAnswer          = NoAnswer_Normal;
11840 }
11841 
11842 mDNSlocal void InitLLQNATState(mDNS *const m)
11843 {
11844     // If we don't have our NAT mapping active, start it now
11845     if (!m->LLQNAT.clientCallback)
11846     {
11847         m->LLQNAT.Protocol       = NATOp_MapUDP;
11848         m->LLQNAT.IntPort        = m->UnicastPort4;
11849         m->LLQNAT.RequestedPort  = m->UnicastPort4;
11850         m->LLQNAT.clientCallback = LLQNATCallback;
11851         m->LLQNAT.clientContext  = (void*)1; // Means LLQ NAT Traversal just started
11852         mDNS_StartNATOperation_internal(m, &m->LLQNAT);
11853     }
11854 }
11855 
11856 mDNSlocal void InitLLQState(DNSQuestion *const question)
11857 {
11858     question->state             = LLQ_InitialRequest;
11859     question->ReqLease          = 0;
11860     question->expire            = 0;
11861     question->ntries            = 0;
11862     question->id                = zeroOpaque64;
11863 }
11864 
11865 #ifdef DNS_PUSH_ENABLED
11866 mDNSlocal void InitDNSPNState(DNSQuestion *const question)
11867 {
11868     question->dnsPushState = DNSPUSH_INIT;
11869 }
11870 #endif // DNS_PUSH_ENABLED
11871 
11872 // InitDNSSECProxyState() is called by mDNS_StartQuery_internal() to initialize
11873 // DNSSEC & DNS Proxy fields of the DNS Question.
11874 mDNSlocal void InitDNSSECProxyState(mDNS *const m, DNSQuestion *const question)
11875 {
11876     (void) m;
11877 
11878     // DNS server selection affects DNSSEC. Turn off validation if req_DO is not set
11879     // or the request is going over cellular interface.
11880     //
11881     // Note: This needs to be done here before we call FindDuplicateQuestion as it looks
11882     // at ValidationRequired setting also.
11883     if (question->qDNSServer)
11884     {
11885         if (question->qDNSServer->cellIntf)
11886         {
11887             debugf("InitDNSSECProxyState: Turning off validation for %##s (%s); going over cell", question->qname.c, DNSTypeName(question->qtype));
11888             question->ValidationRequired = mDNSfalse;
11889         }
11890         if (DNSSECOptionalQuestion(question) && !(question->qDNSServer->req_DO))
11891         {
11892             LogInfo("InitDNSSECProxyState: Turning off validation for %##s (%s); req_DO false",
11893                 question->qname.c, DNSTypeName(question->qtype));
11894             question->ValidationRequired = DNSSEC_VALIDATION_NONE;
11895         }
11896     }
11897     question->ValidationState = (question->ValidationRequired ? DNSSECValRequired : DNSSECValNotRequired);
11898     question->ValidationStatus = 0;
11899     question->responseFlags    = zeroID;
11900 }
11901 
11902 // Once the question is completely initialized including the duplicate logic, this function
11903 // is called to finalize the unicast question which requires flushing the cache if needed,
11904 // activating the query etc.
11905 mDNSlocal void FinalizeUnicastQuestion(mDNS *const m, DNSQuestion *question, mDNSBool purge)
11906 {
11907     // Ensure DNS related info of duplicate question is same as the orig question
11908     if (question->DuplicateOf)
11909     {
11910         question->validDNSServers = question->DuplicateOf->validDNSServers;
11911         // If current(dup) question has DNS Server assigned but the original question has no DNS Server assigned to it,
11912         // then we log a line as it could indicate an issue
11913         if (question->DuplicateOf->qDNSServer == mDNSNULL)
11914         {
11915             if (question->qDNSServer)
11916                 LogInfo("FinalizeUnicastQuestion: Current(dup) question %p has DNSServer(%#a:%d) but original question(%p) has no DNS Server! %##s (%s)",
11917                         question, question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
11918                         mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort),
11919                         question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype));
11920         }
11921         question->qDNSServer = question->DuplicateOf->qDNSServer;
11922         LogInfo("FinalizeUnicastQuestion: Duplicate question %p (%p) %##s (%s), DNS Server %#a:%d",
11923                  question, question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype),
11924                  question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
11925                  mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
11926     }
11927 
11928     ActivateUnicastQuery(m, question, mDNSfalse);
11929 
11930     // If purge was set above, flush the cache. Need to do this after we set the
11931     // DNS server on the question
11932     if (purge)
11933     {
11934         question->DelayAnswering = 0;
11935         mDNS_PurgeForQuestion(m, question);
11936     }
11937     else if (!question->DuplicateOf && DNSSECQuestion(question))
11938     {
11939         // For DNSSEC questions, we need to have the RRSIGs also for verification.
11940         CheckForDNSSECRecords(m, question);
11941     }
11942     if (question->LongLived)
11943     {
11944         // Unlike other initializations, InitLLQNATState should be done after
11945         // we determine that it is a unicast question.  LongLived is set for
11946         // both multicast and unicast browse questions but we should initialize
11947         // the LLQ NAT state only for unicast. Otherwise we will unnecessarily
11948         // start the NAT traversal that is not needed.
11949         InitLLQNATState(m);
11950 #if APPLE_OSX_mDNSResponder
11951         UpdateAutoTunnelDomainStatuses(m);
11952 #endif
11953     }
11954 }
11955 
11956 mDNSexport mStatus mDNS_StartQuery_internal(mDNS *const m, DNSQuestion *const question)
11957 {
11958     DNSQuestion **q;
11959     mStatus vStatus;
11960     mDNSBool purge;
11961 
11962     // First check for cache space (can't do queries if there is no cache space allocated)
11963     if (m->rrcache_size == 0)
11964         return(mStatus_NoCache);
11965 
11966     vStatus = ValidateParameters(m, question);
11967     if (vStatus)
11968         return(vStatus);
11969 
11970 #ifdef USE_LIBIDN
11971     // If the TLD includes high-ascii bytes, assume it will need to be converted to Punycode.
11972     // (In the future the root name servers may answer UTF-8 queries directly, but for now they do not.)
11973     if (IsHighASCIILabel(LastLabel(&question->qname)))
11974     {
11975         domainname newname;
11976         if (PerformNextPunycodeConversion(question, &newname))
11977             AssignDomainName(&question->qname, &newname);
11978     }
11979 #endif // USE_LIBIDN
11980 
11981     question->TargetQID =
11982 #ifndef UNICAST_DISABLED
11983                           (question->Target.type || Question_uDNS(question)) ? mDNS_NewMessageID(m) :
11984 #endif // UNICAST_DISABLED
11985                           zeroID;
11986     debugf("mDNS_StartQuery_internal: %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
11987 
11988     // Note: It important that new questions are appended at the *end* of the list, not prepended at the start
11989     q = &m->Questions;
11990     if (LocalOnlyOrP2PInterface(question->InterfaceID))
11991         q = &m->LocalOnlyQuestions;
11992     while (*q && *q != question)
11993         q=&(*q)->next;
11994 
11995     if (*q)
11996     {
11997         LogMsg("mDNS_StartQuery_internal: Error! Tried to add a question %##s (%s) %p that's already in the active list",
11998                 question->qname.c, DNSTypeName(question->qtype), question);
11999         return(mStatus_AlreadyRegistered);
12000     }
12001     *q = question;
12002 
12003     // Intialize the question. The only ordering constraint we have today is that
12004     // InitDNSSECProxyState should be called after the DNS server is selected (in
12005     // InitCommonState -> InitDNSConfig) as DNS server selection affects DNSSEC
12006     // validation.
12007 
12008     purge = InitCommonState(m, question);
12009     InitWABState(question);
12010     InitLLQState(question);
12011 #ifdef DNS_PUSH_ENABLED
12012     InitDNSPNState(question);
12013 #endif // DNS_PUSH_ENABLED
12014     InitDNSSECProxyState(m, question);
12015 
12016     // FindDuplicateQuestion should be called last after all the intialization
12017     // as the duplicate logic could be potentially based on any field in the
12018     // question.
12019     question->DuplicateOf  = FindDuplicateQuestion(m, question);
12020     if (question->DuplicateOf)
12021         question->AuthInfo = question->DuplicateOf->AuthInfo;
12022 
12023     if (LocalOnlyOrP2PInterface(question->InterfaceID))
12024     {
12025         if (!m->NewLocalOnlyQuestions)
12026             m->NewLocalOnlyQuestions = question;
12027     }
12028     else
12029     {
12030         if (!m->NewQuestions)
12031             m->NewQuestions = question;
12032 
12033         // If the question's id is non-zero, then it's Wide Area
12034         // MUST NOT do this Wide Area setup until near the end of
12035         // mDNS_StartQuery_internal -- this code may itself issue queries (e.g. SOA,
12036         // NS, etc.) and if we haven't finished setting up our own question and setting
12037         // m->NewQuestions if necessary then we could end up recursively re-entering
12038         // this routine with the question list data structures in an inconsistent state.
12039         if (!mDNSOpaque16IsZero(question->TargetQID))
12040         {
12041             FinalizeUnicastQuestion(m, question, purge);
12042         }
12043         else
12044         {
12045 #if BONJOUR_ON_DEMAND
12046             m->NumAllInterfaceQuestions++;
12047             LogInfo("mDNS_StartQuery_internal: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12048                 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12049             if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12050             {
12051                 m->NextBonjourDisableTime = 0;
12052                 if (m->BonjourEnabled == 0)
12053                 {
12054                     // Enable Bonjour immediately by scheduling network changed processing where
12055                     // we will join the multicast group on each active interface.
12056                     m->BonjourEnabled = 1;
12057                     m->NetworkChanged = m->timenow;
12058                 }
12059             }
12060 #endif // BONJOUR_ON_DEMAND
12061             if (purge)
12062             {
12063                 LogInfo("mDNS_StartQuery_internal: Purging for %##s", question->qname.c);
12064                 mDNS_PurgeForQuestion(m, question);
12065             }
12066         }
12067     }
12068 
12069     return(mStatus_NoError);
12070 }
12071 
12072 // CancelGetZoneData is an internal routine (i.e. must be called with the lock already held)
12073 mDNSexport void CancelGetZoneData(mDNS *const m, ZoneData *nta)
12074 {
12075     debugf("CancelGetZoneData %##s (%s)", nta->question.qname.c, DNSTypeName(nta->question.qtype));
12076     // This function may be called anytime to free the zone information.The question may or may not have stopped.
12077     // If it was already stopped, mDNS_StopQuery_internal would have set q->ThisQInterval to -1 and should not
12078     // call it again
12079     if (nta->question.ThisQInterval != -1)
12080     {
12081         mDNS_StopQuery_internal(m, &nta->question);
12082         if (nta->question.ThisQInterval != -1)
12083             LogMsg("CancelGetZoneData: Question %##s (%s) ThisQInterval %d not -1", nta->question.qname.c, DNSTypeName(nta->question.qtype), nta->question.ThisQInterval);
12084     }
12085     mDNSPlatformMemFree(nta);
12086 }
12087 
12088 mDNSexport mStatus mDNS_StopQuery_internal(mDNS *const m, DNSQuestion *const question)
12089 {
12090     CacheGroup *cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12091     CacheRecord *rr;
12092     DNSQuestion **qp = &m->Questions;
12093 
12094     //LogInfo("mDNS_StopQuery_internal %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12095 
12096     if (LocalOnlyOrP2PInterface(question->InterfaceID))
12097         qp = &m->LocalOnlyQuestions;
12098     while (*qp && *qp != question) qp=&(*qp)->next;
12099     if (*qp) *qp = (*qp)->next;
12100     else
12101     {
12102 #if !ForceAlerts
12103         if (question->ThisQInterval >= 0)   // Only log error message if the query was supposed to be active
12104 #endif
12105         LogFatalError("mDNS_StopQuery_internal: Question %##s (%s) not found in active list", question->qname.c, DNSTypeName(question->qtype));
12106         return(mStatus_BadReferenceErr);
12107     }
12108 
12109 #if BONJOUR_ON_DEMAND
12110     if (!LocalOnlyOrP2PInterface(question->InterfaceID) && mDNSOpaque16IsZero(question->TargetQID))
12111     {
12112         if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12113             m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
12114         m->NumAllInterfaceQuestions--;
12115         LogInfo("mDNS_StopQuery_internal:  NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12116             m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12117     }
12118 #endif // BONJOUR_ON_DEMAND
12119 
12120 #if AWD_METRICS
12121     if (Question_uDNS(question) && !question->metrics.answered && (question->metrics.querySendCount > 0))
12122     {
12123         const domainname *  queryName;
12124         mDNSBool            isForCell;
12125         mDNSu32             durationMs;
12126 
12127         queryName  = question->metrics.originalQName ? question->metrics.originalQName : &question->qname;
12128         isForCell  = (question->qDNSServer && question->qDNSServer->cellIntf);
12129         durationMs = ((m->timenow - question->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
12130         MetricsUpdateUDNSQueryStats(queryName, question->qtype, mDNSNULL, question->metrics.querySendCount, durationMs, isForCell);
12131     }
12132 #endif
12133     // Take care to cut question from list *before* calling UpdateQuestionDuplicates
12134     UpdateQuestionDuplicates(m, question);
12135     // But don't trash ThisQInterval until afterwards.
12136     question->ThisQInterval = -1;
12137 
12138     // If there are any cache records referencing this as their active question, then see if there is any
12139     // other question that is also referencing them, else their CRActiveQuestion needs to get set to NULL.
12140     for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12141     {
12142         if (rr->CRActiveQuestion == question)
12143         {
12144             DNSQuestion *q;
12145             DNSQuestion *replacement = mDNSNULL;
12146             // If we find an active question that is answered by this cached record, use it as the cache record's
12147             // CRActiveQuestion replacement. If there are no such questions, but there's at least one unsuppressed inactive
12148             // question that is answered by this cache record, then use an inactive one to not forgo generating RMV events
12149             // via CacheRecordRmv() when the cache record expires.
12150             for (q = m->Questions; q && (q != m->NewQuestions); q = q->next)
12151             {
12152                 if (!q->DuplicateOf && !QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
12153                 {
12154                     if (q->ThisQInterval > 0)
12155                     {
12156                         replacement = q;
12157                         break;
12158                     }
12159                     else if (!replacement)
12160                     {
12161                         replacement = q;
12162                     }
12163                 }
12164             }
12165             if (replacement)
12166                 debugf("mDNS_StopQuery_internal: Updating CRActiveQuestion to %p for cache record %s, Original question CurrentAnswers %d, new question "
12167                        "CurrentAnswers %d, SuppressQuery %d", replacement, CRDisplayString(m,rr), question->CurrentAnswers, replacement->CurrentAnswers, replacement->SuppressQuery);
12168             rr->CRActiveQuestion = replacement;    // Question used to be active; new value may or may not be null
12169             if (!replacement) m->rrcache_active--; // If no longer active, decrement rrcache_active count
12170         }
12171     }
12172 
12173     // If we just deleted the question that CacheRecordAdd() or CacheRecordRmv() is about to look at,
12174     // bump its pointer forward one question.
12175     if (m->CurrentQuestion == question)
12176     {
12177         debugf("mDNS_StopQuery_internal: Just deleted the currently active question: %##s (%s)",
12178                question->qname.c, DNSTypeName(question->qtype));
12179         m->CurrentQuestion = question->next;
12180     }
12181 
12182     if (m->NewQuestions == question)
12183     {
12184         debugf("mDNS_StopQuery_internal: Just deleted a new question that wasn't even answered yet: %##s (%s)",
12185                question->qname.c, DNSTypeName(question->qtype));
12186         m->NewQuestions = question->next;
12187     }
12188 
12189     if (m->NewLocalOnlyQuestions == question) m->NewLocalOnlyQuestions = question->next;
12190 
12191     if (m->RestartQuestion == question)
12192     {
12193         LogMsg("mDNS_StopQuery_internal: Just deleted the current restart question: %##s (%s)",
12194                question->qname.c, DNSTypeName(question->qtype));
12195         m->RestartQuestion = question->next;
12196     }
12197 
12198     if (m->ValidationQuestion == question)
12199     {
12200         LogInfo("mDNS_StopQuery_internal: Just deleted the current Validation question: %##s (%s)",
12201                question->qname.c, DNSTypeName(question->qtype));
12202         m->ValidationQuestion = question->next;
12203     }
12204 
12205     // Take care not to trash question->next until *after* we've updated m->CurrentQuestion and m->NewQuestions
12206     question->next = mDNSNULL;
12207 
12208     // LogMsg("mDNS_StopQuery_internal: Question %##s (%s) removed", question->qname.c, DNSTypeName(question->qtype));
12209 
12210     // And finally, cancel any associated GetZoneData operation that's still running.
12211     // Must not do this until last, because there's a good chance the GetZoneData question is the next in the list,
12212     // so if we delete it earlier in this routine, we could find that our "question->next" pointer above is already
12213     // invalid before we even use it. By making sure that we update m->CurrentQuestion and m->NewQuestions if necessary
12214     // *first*, then they're all ready to be updated a second time if necessary when we cancel our GetZoneData query.
12215     if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
12216     if (question->LocalSocket) { mDNSPlatformUDPClose(question->LocalSocket); question->LocalSocket = mDNSNULL; }
12217     if (!mDNSOpaque16IsZero(question->TargetQID) && question->LongLived)
12218     {
12219         // Scan our list to see if any more wide-area LLQs remain. If not, stop our NAT Traversal.
12220         DNSQuestion *q;
12221         for (q = m->Questions; q; q=q->next)
12222             if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived) break;
12223         if (!q)
12224         {
12225             if (!m->LLQNAT.clientCallback)       // Should never happen, but just in case...
12226             {
12227                 LogMsg("mDNS_StopQuery ERROR LLQNAT.clientCallback NULL");
12228             }
12229             else
12230             {
12231                 LogInfo("Stopping LLQNAT");
12232                 mDNS_StopNATOperation_internal(m, &m->LLQNAT);
12233                 m->LLQNAT.clientCallback = mDNSNULL; // Means LLQ NAT Traversal not running
12234             }
12235         }
12236 
12237         // If necessary, tell server it can delete this LLQ state
12238         if (question->state == LLQ_Established)
12239         {
12240             question->ReqLease = 0;
12241             sendLLQRefresh(m, question);
12242             // If we need need to make a TCP connection to cancel the LLQ, that's going to take a little while.
12243             // We clear the tcp->question backpointer so that when the TCP connection completes, it doesn't
12244             // crash trying to access our cancelled question, but we don't cancel the TCP operation itself --
12245             // we let that run out its natural course and complete asynchronously.
12246             if (question->tcp)
12247             {
12248                 question->tcp->question = mDNSNULL;
12249                 question->tcp           = mDNSNULL;
12250             }
12251         }
12252 #ifdef DNS_PUSH_ENABLED
12253         else if (question->dnsPushState == DNSPUSH_ESTABLISHED)
12254         {
12255             if (question->tcp)
12256             {
12257                 UnSubscribeToDNSPushNotificationServer(m, q);
12258                 question->tcp->question = mDNSNULL;
12259                 question->tcp           = mDNSNULL;
12260             }
12261         }
12262 #endif // DNS_PUSH_ENABLED
12263 #if APPLE_OSX_mDNSResponder
12264         UpdateAutoTunnelDomainStatuses(m);
12265 #endif
12266     }
12267     // wait until we send the refresh above which needs the nta
12268     if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
12269 
12270     if (question->ValidationRequired && question->DNSSECAuthInfo)
12271     {
12272         LogInfo("mDNS_StopQuery_internal: freeing DNSSECAuthInfo %##s", question->qname.c);
12273         question->DAIFreeCallback(m, question->DNSSECAuthInfo);
12274         question->DNSSECAuthInfo = mDNSNULL;
12275     }
12276     if (question->AnonInfo)
12277     {
12278         FreeAnonInfo(question->AnonInfo);
12279         question->AnonInfo = mDNSNULL;
12280     }
12281 #if AWD_METRICS
12282     if (question->metrics.originalQName)
12283     {
12284         mDNSPlatformMemFree(question->metrics.originalQName);
12285         question->metrics.originalQName = mDNSNULL;
12286     }
12287 #endif
12288 
12289 #if USE_DNS64
12290     DNS64ResetState(question);
12291 #endif
12292 
12293     return(mStatus_NoError);
12294 }
12295 
12296 mDNSexport mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question)
12297 {
12298     mStatus status;
12299     mDNS_Lock(m);
12300     status = mDNS_StartQuery_internal(m, question);
12301     mDNS_Unlock(m);
12302     return(status);
12303 }
12304 
12305 mDNSexport mStatus mDNS_StopQuery(mDNS *const m, DNSQuestion *const question)
12306 {
12307     mStatus status;
12308     mDNS_Lock(m);
12309     status = mDNS_StopQuery_internal(m, question);
12310     mDNS_Unlock(m);
12311     return(status);
12312 }
12313 
12314 // Note that mDNS_StopQueryWithRemoves() does not currently implement the full generality of the other APIs
12315 // Specifically, question callbacks invoked as a result of this call cannot themselves make API calls.
12316 // We invoke the callback without using mDNS_DropLockBeforeCallback/mDNS_ReclaimLockAfterCallback
12317 // specifically to catch and report if the client callback does try to make API calls
12318 mDNSexport mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question)
12319 {
12320     mStatus status;
12321     DNSQuestion *qq;
12322     mDNS_Lock(m);
12323 
12324     // Check if question is new -- don't want to give remove events for a question we haven't even answered yet
12325     for (qq = m->NewQuestions; qq; qq=qq->next) if (qq == question) break;
12326 
12327     status = mDNS_StopQuery_internal(m, question);
12328     if (status == mStatus_NoError && !qq)
12329     {
12330         const CacheRecord *rr;
12331         CacheGroup *const cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12332         LogInfo("Generating terminal removes for %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12333         for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12334             if (rr->resrec.RecordType != kDNSRecordTypePacketNegative && SameNameRecordAnswersQuestion(&rr->resrec, question))
12335             {
12336                 // Don't use mDNS_DropLockBeforeCallback() here, since we don't allow API calls
12337                 if (question->QuestionCallback)
12338                     question->QuestionCallback(m, question, &rr->resrec, mDNSfalse);
12339             }
12340     }
12341     mDNS_Unlock(m);
12342     return(status);
12343 }
12344 
12345 mDNSexport mStatus mDNS_Reconfirm(mDNS *const m, CacheRecord *const cr)
12346 {
12347     mStatus status;
12348     mDNS_Lock(m);
12349     status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12350     if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, 0);
12351     mDNS_Unlock(m);
12352     return(status);
12353 }
12354 
12355 mDNSexport mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr)
12356 {
12357     mStatus status = mStatus_BadReferenceErr;
12358     CacheRecord *cr;
12359     mDNS_Lock(m);
12360     cr = FindIdenticalRecordInCache(m, rr);
12361     debugf("mDNS_ReconfirmByValue: %p %s", cr, RRDisplayString(m, rr));
12362     if (cr) status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12363     if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, 0);
12364     mDNS_Unlock(m);
12365     return(status);
12366 }
12367 
12368 mDNSlocal mStatus mDNS_StartBrowse_internal(mDNS *const m, DNSQuestion *const question,
12369                                             const domainname *const srv, const domainname *const domain,
12370                                             const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12371                                             mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12372                                             mDNSQuestionCallback *Callback, void *Context)
12373 {
12374     question->InterfaceID      = InterfaceID;
12375     question->flags            = flags;
12376     question->Target           = zeroAddr;
12377     question->qtype            = kDNSType_PTR;
12378     question->qclass           = kDNSClass_IN;
12379     question->LongLived        = mDNStrue;
12380     question->ExpectUnique     = mDNSfalse;
12381     question->ForceMCast       = ForceMCast;
12382     question->ReturnIntermed   = (flags & kDNSServiceFlagsReturnIntermediates) != 0;
12383     question->SuppressUnusable = mDNSfalse;
12384     question->SearchListIndex  = 0;
12385     question->AppendSearchDomains = 0;
12386     question->RetryWithSearchDomains = mDNSfalse;
12387     question->TimeoutQuestion  = 0;
12388     question->WakeOnResolve    = 0;
12389     question->UseBackgroundTrafficClass = useBackgroundTrafficClass;
12390     question->ValidationRequired = 0;
12391     question->ValidatingResponse = 0;
12392     question->ProxyQuestion    = 0;
12393     question->qnameOrig        = mDNSNULL;
12394     question->AnonInfo         = mDNSNULL;
12395     question->QuestionCallback = Callback;
12396     question->QuestionContext  = Context;
12397 
12398     if (!ConstructServiceName(&question->qname, mDNSNULL, srv, domain))
12399         return(mStatus_BadParamErr);
12400 
12401     if (anondata)
12402     {
12403         question->AnonInfo = AllocateAnonInfo(&question->qname, anondata, mDNSPlatformStrLen(anondata), mDNSNULL);
12404         if (!question->AnonInfo)
12405             return(mStatus_BadParamErr);
12406     }
12407 
12408     return(mDNS_StartQuery_internal(m, question));
12409 }
12410 
12411 mDNSexport mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question,
12412                                     const domainname *const srv, const domainname *const domain,
12413                                     const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12414                                     mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12415                                     mDNSQuestionCallback *Callback, void *Context)
12416 {
12417     mStatus status;
12418     mDNS_Lock(m);
12419     status = mDNS_StartBrowse_internal(m, question, srv, domain, anondata, InterfaceID, flags, ForceMCast, useBackgroundTrafficClass, Callback, Context);
12420     mDNS_Unlock(m);
12421     return(status);
12422 }
12423 
12424 
12425 mDNSexport mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom,
12426                                    const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context)
12427 {
12428     question->InterfaceID      = InterfaceID;
12429     question->flags            = 0;
12430     question->Target           = zeroAddr;
12431     question->qtype            = kDNSType_PTR;
12432     question->qclass           = kDNSClass_IN;
12433     question->LongLived        = mDNSfalse;
12434     question->ExpectUnique     = mDNSfalse;
12435     question->ForceMCast       = mDNSfalse;
12436     question->ReturnIntermed   = mDNSfalse;
12437     question->SuppressUnusable = mDNSfalse;
12438     question->SearchListIndex  = 0;
12439     question->AppendSearchDomains = 0;
12440     question->RetryWithSearchDomains = mDNSfalse;
12441     question->TimeoutQuestion  = 0;
12442     question->WakeOnResolve    = 0;
12443     question->UseBackgroundTrafficClass = mDNSfalse;
12444     question->ValidationRequired = 0;
12445     question->ValidatingResponse = 0;
12446     question->ProxyQuestion    = 0;
12447     question->qnameOrig        = mDNSNULL;
12448     question->AnonInfo         = mDNSNULL;
12449     question->pid              = mDNSPlatformGetPID();
12450     question->euid             = 0;
12451     question->QuestionCallback = Callback;
12452     question->QuestionContext  = Context;
12453     if (DomainType > mDNS_DomainTypeMax) return(mStatus_BadParamErr);
12454     if (!MakeDomainNameFromDNSNameString(&question->qname, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
12455     if (!dom) dom = &localdomain;
12456     if (!AppendDomainName(&question->qname, dom)) return(mStatus_BadParamErr);
12457     return(mDNS_StartQuery(m, question));
12458 }
12459 
12460 // ***************************************************************************
12461 #if COMPILER_LIKES_PRAGMA_MARK
12462 #pragma mark -
12463 #pragma mark - Responder Functions
12464 #endif
12465 
12466 mDNSexport mStatus mDNS_Register(mDNS *const m, AuthRecord *const rr)
12467 {
12468     mStatus status;
12469     mDNS_Lock(m);
12470     status = mDNS_Register_internal(m, rr);
12471     mDNS_Unlock(m);
12472     return(status);
12473 }
12474 
12475 mDNSexport mStatus mDNS_Update(mDNS *const m, AuthRecord *const rr, mDNSu32 newttl,
12476                                const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback)
12477 {
12478     if (!ValidateRData(rr->resrec.rrtype, newrdlength, newrdata))
12479     {
12480         LogMsg("Attempt to update record with invalid rdata: %s", GetRRDisplayString_rdb(&rr->resrec, &newrdata->u, m->MsgBuffer));
12481         return(mStatus_Invalid);
12482     }
12483 
12484     mDNS_Lock(m);
12485 
12486     // If TTL is unspecified, leave TTL unchanged
12487     if (newttl == 0) newttl = rr->resrec.rroriginalttl;
12488 
12489     // If we already have an update queued up which has not gone through yet, give the client a chance to free that memory
12490     if (rr->NewRData)
12491     {
12492         RData *n = rr->NewRData;
12493         rr->NewRData = mDNSNULL;                            // Clear the NewRData pointer ...
12494         if (rr->UpdateCallback)
12495             rr->UpdateCallback(m, rr, n, rr->newrdlength);  // ...and let the client free this memory, if necessary
12496     }
12497 
12498     rr->NewRData             = newrdata;
12499     rr->newrdlength          = newrdlength;
12500     rr->UpdateCallback       = Callback;
12501 
12502 #ifndef UNICAST_DISABLED
12503     if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P && !IsLocalDomain(rr->resrec.name))
12504     {
12505         mStatus status = uDNS_UpdateRecord(m, rr);
12506         // The caller frees the memory on error, don't retain stale pointers
12507         if (status != mStatus_NoError) { rr->NewRData = mDNSNULL; rr->newrdlength = 0; }
12508         mDNS_Unlock(m);
12509         return(status);
12510     }
12511 #endif
12512 
12513     if (RRLocalOnly(rr) || (rr->resrec.rroriginalttl == newttl &&
12514                             rr->resrec.rdlength == newrdlength && mDNSPlatformMemSame(rr->resrec.rdata->u.data, newrdata->u.data, newrdlength)))
12515         CompleteRDataUpdate(m, rr);
12516     else
12517     {
12518         rr->AnnounceCount = InitialAnnounceCount;
12519         InitializeLastAPTime(m, rr);
12520         while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
12521         if (!rr->UpdateBlocked && rr->UpdateCredits) rr->UpdateCredits--;
12522         if (!rr->NextUpdateCredit) rr->NextUpdateCredit = NonZeroTime(m->timenow + kUpdateCreditRefreshInterval);
12523         if (rr->AnnounceCount > rr->UpdateCredits + 1) rr->AnnounceCount = (mDNSu8)(rr->UpdateCredits + 1);
12524         if (rr->UpdateCredits <= 5)
12525         {
12526             mDNSu32 delay = 6 - rr->UpdateCredits;      // Delay 1 second, then 2, then 3, etc. up to 6 seconds maximum
12527             if (!rr->UpdateBlocked) rr->UpdateBlocked = NonZeroTime(m->timenow + (mDNSs32)delay * mDNSPlatformOneSecond);
12528             rr->ThisAPInterval *= 4;
12529             rr->LastAPTime = rr->UpdateBlocked - rr->ThisAPInterval;
12530             LogMsg("Excessive update rate for %##s; delaying announcement by %ld second%s",
12531                    rr->resrec.name->c, delay, delay > 1 ? "s" : "");
12532         }
12533         rr->resrec.rroriginalttl = newttl;
12534     }
12535 
12536     mDNS_Unlock(m);
12537     return(mStatus_NoError);
12538 }
12539 
12540 // Note: mDNS_Deregister calls mDNS_Deregister_internal which can call a user callback, which may change
12541 // the record list and/or question list.
12542 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
12543 mDNSexport mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr)
12544 {
12545     mStatus status;
12546     mDNS_Lock(m);
12547     status = mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
12548     mDNS_Unlock(m);
12549     return(status);
12550 }
12551 
12552 // Circular reference: AdvertiseInterface references mDNS_HostNameCallback, which calls mDNS_SetFQDN, which call AdvertiseInterface
12553 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
12554 
12555 mDNSlocal NetworkInterfaceInfo *FindFirstAdvertisedInterface(mDNS *const m)
12556 {
12557     NetworkInterfaceInfo *intf;
12558     for (intf = m->HostInterfaces; intf; intf = intf->next)
12559         if (intf->Advertise) break;
12560     return(intf);
12561 }
12562 
12563 // The parameter "set" here refers to the set of AuthRecords used to advertise this interface.
12564 // (It's a set of records, not a set of interfaces.)
12565 mDNSlocal void AdvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12566 {
12567     char buffer[MAX_REVERSE_MAPPING_NAME];
12568     NetworkInterfaceInfo *primary;
12569     mDNSu8 recordType;
12570 
12571     if (m->AutoTargetServices == 0)
12572     {
12573         LogInfo("AdvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12574         return;
12575     }
12576 
12577     primary = FindFirstAdvertisedInterface(m);
12578     if (!primary) primary = set; // If no existing advertised interface, this new NetworkInterfaceInfo becomes our new primary
12579     // We should never have primary be NULL, because even if there is
12580     // no other interface yet, we should always find ourself in the list.
12581 
12582     // If interface is marked as a direct link, we can assume the address record is unique
12583     // and does not need to go through the probe phase of the probe/announce packet sequence.
12584     recordType = (set->DirectLink ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique);
12585 
12586     if (set->DirectLink)
12587         LogInfo("AdvertiseInterface: Marking address record as kDNSRecordTypeKnownUnique for %s", set->ifname);
12588 
12589     // Send dynamic update for non-linklocal IPv4 Addresses
12590     mDNS_SetupResourceRecord(&set->RR_A,     mDNSNULL, set->InterfaceID, kDNSType_A,     kHostNameTTL, recordType,                AuthRecordAny, mDNS_HostNameCallback, set);
12591     mDNS_SetupResourceRecord(&set->RR_PTR,   mDNSNULL, set->InterfaceID, kDNSType_PTR,   kHostNameTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL,              mDNSNULL);
12592     mDNS_SetupResourceRecord(&set->RR_HINFO, mDNSNULL, set->InterfaceID, kDNSType_HINFO, kHostNameTTL, kDNSRecordTypeUnique,      AuthRecordAny, mDNSNULL,              mDNSNULL);
12593 
12594 #if ANSWER_REMOTE_HOSTNAME_QUERIES
12595     set->RR_A.AllowRemoteQuery  = mDNStrue;
12596     set->RR_PTR.AllowRemoteQuery  = mDNStrue;
12597     set->RR_HINFO.AllowRemoteQuery  = mDNStrue;
12598 #endif
12599     // 1. Set up Address record to map from host name ("foo.local.") to IP address
12600     // 2. Set up reverse-lookup PTR record to map from our address back to our host name
12601     AssignDomainName(&set->RR_A.namestorage, &m->MulticastHostname);
12602     if (set->ip.type == mDNSAddrType_IPv4)
12603     {
12604         set->RR_A.resrec.rrtype = kDNSType_A;
12605         set->RR_A.resrec.rdata->u.ipv4 = set->ip.ip.v4;
12606         // Note: This is reverse order compared to a normal dotted-decimal IP address, so we can't use our customary "%.4a" format code
12607         mDNS_snprintf(buffer, sizeof(buffer), "%d.%d.%d.%d.in-addr.arpa.",
12608                       set->ip.ip.v4.b[3], set->ip.ip.v4.b[2], set->ip.ip.v4.b[1], set->ip.ip.v4.b[0]);
12609     }
12610     else if (set->ip.type == mDNSAddrType_IPv6)
12611     {
12612         int i;
12613         set->RR_A.resrec.rrtype = kDNSType_AAAA;
12614         set->RR_A.resrec.rdata->u.ipv6 = set->ip.ip.v6;
12615         for (i = 0; i < 16; i++)
12616         {
12617             static const char hexValues[] = "0123456789ABCDEF";
12618             buffer[i * 4    ] = hexValues[set->ip.ip.v6.b[15 - i] & 0x0F];
12619             buffer[i * 4 + 1] = '.';
12620             buffer[i * 4 + 2] = hexValues[set->ip.ip.v6.b[15 - i] >> 4];
12621             buffer[i * 4 + 3] = '.';
12622         }
12623         mDNS_snprintf(&buffer[64], sizeof(buffer)-64, "ip6.arpa.");
12624     }
12625 
12626     MakeDomainNameFromDNSNameString(&set->RR_PTR.namestorage, buffer);
12627     set->RR_PTR.AutoTarget = Target_AutoHost;   // Tell mDNS that the target of this PTR is to be kept in sync with our host name
12628     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
12629 
12630     set->RR_A.RRSet = &primary->RR_A;           // May refer to self
12631 
12632     mDNS_Register_internal(m, &set->RR_A);
12633     mDNS_Register_internal(m, &set->RR_PTR);
12634 
12635 #if APPLE_OSX_mDNSResponder
12636     // must be after the mDNS_Register_internal() calls so that records have complete rdata fields, etc
12637     D2D_start_advertising_interface(set);
12638 #endif // APPLE_OSX_mDNSResponder
12639 
12640     if (!NO_HINFO && m->HIHardware.c[0] > 0 && m->HISoftware.c[0] > 0 && m->HIHardware.c[0] + m->HISoftware.c[0] <= 254)
12641     {
12642         mDNSu8 *p = set->RR_HINFO.resrec.rdata->u.data;
12643         AssignDomainName(&set->RR_HINFO.namestorage, &m->MulticastHostname);
12644         set->RR_HINFO.DependentOn = &set->RR_A;
12645         mDNSPlatformMemCopy(p, &m->HIHardware, 1 + (mDNSu32)m->HIHardware.c[0]);
12646         p += 1 + (int)p[0];
12647         mDNSPlatformMemCopy(p, &m->HISoftware, 1 + (mDNSu32)m->HISoftware.c[0]);
12648         mDNS_Register_internal(m, &set->RR_HINFO);
12649     }
12650     else
12651     {
12652         debugf("Not creating HINFO record: platform support layer provided no information");
12653         set->RR_HINFO.resrec.RecordType = kDNSRecordTypeUnregistered;
12654     }
12655 }
12656 
12657 mDNSlocal void DeadvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12658 {
12659     if (m->AutoTargetServices == 0)
12660     {
12661         LogInfo("DeadvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12662         return;
12663     }
12664 
12665 #if APPLE_OSX_mDNSResponder
12666     D2D_stop_advertising_interface(set);
12667 #endif // APPLE_OSX_mDNSResponder
12668 
12669     // Unregister these records.
12670     // When doing the mDNS_Exit processing, we first call DeadvertiseInterface for each interface, so by the time the platform
12671     // support layer gets to call mDNS_DeregisterInterface, the address and PTR records have already been deregistered for it.
12672     // Also, in the event of a name conflict, one or more of our records will have been forcibly deregistered.
12673     // To avoid unnecessary and misleading warning messages, we check the RecordType before calling mDNS_Deregister_internal().
12674     if (set->RR_A    .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_A,     mDNS_Dereg_normal);
12675     if (set->RR_PTR  .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_PTR,   mDNS_Dereg_normal);
12676     if (set->RR_HINFO.resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_HINFO, mDNS_Dereg_normal);
12677 }
12678 
12679 mDNSlocal void AdvertiseAllInterfaceRecords(mDNS *const m)
12680 {
12681     NetworkInterfaceInfo *intf;
12682     for (intf = m->HostInterfaces; intf; intf = intf->next)
12683     {
12684         if (intf->Advertise)
12685         {
12686             LogInfo("AdvertiseInterface: Advertising for ifname %s", intf->ifname);
12687             AdvertiseInterface(m, intf);
12688         }
12689     }
12690 }
12691 
12692 mDNSlocal void DeadvertiseAllInterfaceRecords(mDNS *const m)
12693 {
12694     NetworkInterfaceInfo *intf;
12695     for (intf = m->HostInterfaces; intf; intf = intf->next)
12696     {
12697         if (intf->Advertise)
12698         {
12699             LogInfo("DeadvertiseInterface: Deadvertising for ifname %s", intf->ifname);
12700             DeadvertiseInterface(m, intf);
12701         }
12702     }
12703 }
12704 
12705 // Change target host name for record.
12706 mDNSlocal void UpdateTargetHostName(mDNS *const m, AuthRecord *const rr)
12707 {
12708 #if APPLE_OSX_mDNSResponder
12709         // If this record was also registered with any D2D plugins, stop advertising
12710         // the version with the old host name.
12711         D2D_stop_advertising_record(rr);
12712 #endif
12713 
12714     SetTargetToHostName(m, rr);
12715 
12716 #if APPLE_OSX_mDNSResponder
12717         // Advertise the record with the updated host name with the D2D plugins if appropriate.
12718         D2D_start_advertising_record(rr);
12719 #endif
12720 }
12721 
12722 mDNSexport void mDNS_SetFQDN(mDNS *const m)
12723 {
12724     domainname newmname;
12725     AuthRecord *rr;
12726     newmname.c[0] = 0;
12727 
12728     if (!AppendDomainLabel(&newmname, &m->hostlabel))  { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12729     if (!AppendLiteralLabelString(&newmname, "local")) { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12730 
12731     mDNS_Lock(m);
12732 
12733     if (SameDomainNameCS(&m->MulticastHostname, &newmname)) debugf("mDNS_SetFQDN - hostname unchanged");
12734     else
12735     {
12736         AssignDomainName(&m->MulticastHostname, &newmname);
12737         DeadvertiseAllInterfaceRecords(m);
12738         AdvertiseAllInterfaceRecords(m);
12739     }
12740 
12741     // 3. Make sure that any AutoTarget SRV records (and the like) get updated
12742     for (rr = m->ResourceRecords;  rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12743     for (rr = m->DuplicateRecords; rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12744 
12745     mDNS_Unlock(m);
12746 }
12747 
12748 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
12749 {
12750     (void)rr;   // Unused parameter
12751 
12752     #if MDNS_DEBUGMSGS
12753     {
12754         char *msg = "Unknown result";
12755         if      (result == mStatus_NoError) msg = "Name registered";
12756         else if (result == mStatus_NameConflict) msg = "Name conflict";
12757         debugf("mDNS_HostNameCallback: %##s (%s) %s (%ld)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
12758     }
12759     #endif
12760 
12761     if (result == mStatus_NoError)
12762     {
12763         // Notify the client that the host name is successfully registered
12764         if (m->MainCallback)
12765             m->MainCallback(m, mStatus_NoError);
12766     }
12767     else if (result == mStatus_NameConflict)
12768     {
12769         domainlabel oldlabel = m->hostlabel;
12770 
12771         // 1. First give the client callback a chance to pick a new name
12772         if (m->MainCallback)
12773             m->MainCallback(m, mStatus_NameConflict);
12774 
12775         // 2. If the client callback didn't do it, add (or increment) an index ourselves
12776         // This needs to be case-INSENSITIVE compare, because we need to know that the name has been changed so as to
12777         // remedy the conflict, and a name that differs only in capitalization will just suffer the exact same conflict again.
12778         if (SameDomainLabel(m->hostlabel.c, oldlabel.c))
12779             IncrementLabelSuffix(&m->hostlabel, mDNSfalse);
12780 
12781         // 3. Generate the FQDNs from the hostlabel,
12782         // and make sure all SRV records, etc., are updated to reference our new hostname
12783         mDNS_SetFQDN(m);
12784         LogMsg("Local Hostname %#s.local already in use; will try %#s.local instead", oldlabel.c, m->hostlabel.c);
12785     }
12786     else if (result == mStatus_MemFree)
12787     {
12788         // .local hostnames do not require goodbyes - we ignore the MemFree (which is sent directly by
12789         // mDNS_Deregister_internal), and allow the caller to deallocate immediately following mDNS_DeadvertiseInterface
12790         debugf("mDNS_HostNameCallback: MemFree (ignored)");
12791     }
12792     else
12793         LogMsg("mDNS_HostNameCallback: Unknown error %d for registration of record %s", result,  rr->resrec.name->c);
12794 }
12795 
12796 mDNSlocal void UpdateInterfaceProtocols(mDNS *const m, NetworkInterfaceInfo *active)
12797 {
12798     NetworkInterfaceInfo *intf;
12799     active->IPv4Available = mDNSfalse;
12800     active->IPv6Available = mDNSfalse;
12801     for (intf = m->HostInterfaces; intf; intf = intf->next)
12802         if (intf->InterfaceID == active->InterfaceID)
12803         {
12804             if (intf->ip.type == mDNSAddrType_IPv4 && intf->McastTxRx) active->IPv4Available = mDNStrue;
12805             if (intf->ip.type == mDNSAddrType_IPv6 && intf->McastTxRx) active->IPv6Available = mDNStrue;
12806         }
12807 }
12808 
12809 mDNSlocal void RestartRecordGetZoneData(mDNS * const m)
12810 {
12811     AuthRecord *rr;
12812     LogInfo("RestartRecordGetZoneData: ResourceRecords");
12813     for (rr = m->ResourceRecords; rr; rr=rr->next)
12814         if (AuthRecord_uDNS(rr) && rr->state != regState_NoTarget)
12815         {
12816             debugf("RestartRecordGetZoneData: StartGetZoneData for %##s", rr->resrec.name->c);
12817             // Zero out the updateid so that if we have a pending response from the server, it won't
12818             // be accepted as a valid response. If we accept the response, we might free the new "nta"
12819             if (rr->nta) { rr->updateid = zeroID; CancelGetZoneData(m, rr->nta); }
12820             rr->nta = StartGetZoneData(m, rr->resrec.name, ZoneServiceUpdate, RecordRegistrationGotZoneData, rr);
12821         }
12822 }
12823 
12824 mDNSlocal void InitializeNetWakeState(mDNS *const m, NetworkInterfaceInfo *set)
12825 {
12826     int i;
12827     // We initialize ThisQInterval to -1 indicating that the question has not been started
12828     // yet. If the question (browse) is started later during interface registration, it will
12829     // be stopped during interface deregistration. We can't sanity check to see if the
12830     // question has been stopped or not before initializing it to -1 because we need to
12831     // initialize it to -1 the very first time.
12832 
12833     set->NetWakeBrowse.ThisQInterval = -1;
12834     for (i=0; i<3; i++)
12835     {
12836         set->NetWakeResolve[i].ThisQInterval = -1;
12837         set->SPSAddr[i].type = mDNSAddrType_None;
12838     }
12839     set->NextSPSAttempt     = -1;
12840     set->NextSPSAttemptTime = m->timenow;
12841 }
12842 
12843 mDNSexport void mDNS_ActivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12844 {
12845     NetworkInterfaceInfo *p = m->HostInterfaces;
12846     while (p && p != set) p=p->next;
12847     if (!p) { LogMsg("mDNS_ActivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12848 
12849     if (set->InterfaceActive)
12850     {
12851         LogSPS("ActivateNetWake for %s (%#a)", set->ifname, &set->ip);
12852         mDNS_StartBrowse_internal(m, &set->NetWakeBrowse, &SleepProxyServiceType, &localdomain, mDNSNULL, set->InterfaceID, 0, mDNSfalse, mDNSfalse, m->SPSBrowseCallback, set);
12853     }
12854 }
12855 
12856 mDNSexport void mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12857 {
12858     NetworkInterfaceInfo *p = m->HostInterfaces;
12859     while (p && p != set) p=p->next;
12860     if (!p) { LogMsg("mDNS_DeactivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12861 
12862     // Note: We start the browse only if the interface is NetWake capable and we use this to
12863     // stop the resolves also. Hence, the resolves should not be started without the browse
12864     // being started i.e, resolves should not happen unless NetWake capable which is
12865     // guaranteed by BeginSleepProcessing.
12866     if (set->NetWakeBrowse.ThisQInterval >= 0)
12867     {
12868         int i;
12869         LogSPS("DeactivateNetWake for %s (%#a)", set->ifname, &set->ip);
12870 
12871         // Stop our browse and resolve operations
12872         mDNS_StopQuery_internal(m, &set->NetWakeBrowse);
12873         for (i=0; i<3; i++) if (set->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery_internal(m, &set->NetWakeResolve[i]);
12874 
12875         // Make special call to the browse callback to let it know it can to remove all records for this interface
12876         if (m->SPSBrowseCallback)
12877         {
12878             mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
12879             m->SPSBrowseCallback(m, &set->NetWakeBrowse, mDNSNULL, mDNSfalse);
12880             mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
12881         }
12882 
12883         // Reset our variables back to initial state, so we're ready for when NetWake is turned back on
12884         // (includes resetting NetWakeBrowse.ThisQInterval back to -1)
12885         InitializeNetWakeState(m, set);
12886     }
12887 }
12888 
12889 mDNSexport mStatus mDNS_RegisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
12890 {
12891     AuthRecord *rr;
12892     mDNSBool FirstOfType = mDNStrue;
12893     NetworkInterfaceInfo **p = &m->HostInterfaces;
12894 
12895     if (!set->InterfaceID)
12896     { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with zero InterfaceID", &set->ip); return(mStatus_Invalid); }
12897 
12898     if (!mDNSAddressIsValidNonZero(&set->mask))
12899     { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with invalid mask %#a", &set->ip, &set->mask); return(mStatus_Invalid); }
12900 
12901     mDNS_Lock(m);
12902 
12903     // Assume this interface will be active now, unless we find a duplicate already in the list
12904     set->InterfaceActive = mDNStrue;
12905     set->IPv4Available   = (mDNSu8)(set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx);
12906     set->IPv6Available   = (mDNSu8)(set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx);
12907 
12908     InitializeNetWakeState(m, set);
12909 
12910     // Scan list to see if this InterfaceID is already represented
12911     while (*p)
12912     {
12913         if (*p == set)
12914         {
12915             LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo that's already in the list");
12916             mDNS_Unlock(m);
12917             return(mStatus_AlreadyRegistered);
12918         }
12919 
12920         if ((*p)->InterfaceID == set->InterfaceID)
12921         {
12922             // This InterfaceID already represented by a different interface in the list, so mark this instance inactive for now
12923             set->InterfaceActive = mDNSfalse;
12924             if (set->ip.type == (*p)->ip.type) FirstOfType = mDNSfalse;
12925             if (set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx) (*p)->IPv4Available = mDNStrue;
12926             if (set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx) (*p)->IPv6Available = mDNStrue;
12927         }
12928 
12929         p=&(*p)->next;
12930     }
12931 
12932     set->next = mDNSNULL;
12933     *p = set;
12934 
12935     if (set->Advertise)
12936         AdvertiseInterface(m, set);
12937 
12938     LogInfo("mDNS_RegisterInterface: InterfaceID %d %s (%#a) %s",
12939             (uint32_t)set->InterfaceID, set->ifname, &set->ip,
12940             set->InterfaceActive ?
12941             "not represented in list; marking active and retriggering queries" :
12942             "already represented in list; marking inactive for now");
12943 
12944     if (set->NetWake) mDNS_ActivateNetWake_internal(m, set);
12945 
12946     // In early versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
12947     // giving the false impression that there's an active representative of this interface when there really isn't.
12948     // Therefore, when registering an interface, we want to re-trigger our questions and re-probe our Resource Records,
12949     // even if we believe that we previously had an active representative of this interface.
12950     if (set->McastTxRx && (FirstOfType || set->InterfaceActive))
12951     {
12952         DNSQuestion *q;
12953         // Normally, after an interface comes up, we pause half a second before beginning probing.
12954         // This is to guard against cases where there's rapid interface changes, where we could be confused by
12955         // seeing packets we ourselves sent just moments ago (perhaps when this interface had a different address)
12956         // which are then echoed back after a short delay by some Ethernet switches and some 802.11 base stations.
12957         // We don't want to do a probe, and then see a stale echo of an announcement we ourselves sent,
12958         // and think it's a conflicting answer to our probe.
12959         // In the case of a flapping interface, we pause for five seconds, and reduce the announcement count to one packet.
12960         mDNSs32 probedelay;
12961         mDNSu8 numannounce;
12962         switch (activationSpeed)
12963         {
12964             case FastActivation:
12965                 probedelay = (mDNSs32)0;
12966                 numannounce = InitialAnnounceCount;
12967                 LogMsg("mDNS_RegisterInterface: Using fast activation for DirectLink interface %s (%#a)", set->ifname, &set->ip);
12968                 break;
12969 
12970             case SlowActivation:
12971                 probedelay = mDNSPlatformOneSecond * 5;
12972                 numannounce = (mDNSu8)1;
12973                 LogMsg("mDNS_RegisterInterface: Frequent transitions for interface %s (%#a), doing slow activation", set->ifname, &set->ip);
12974                 m->mDNSStats.InterfaceUpFlap++;
12975                 break;
12976 
12977             case NormalActivation:
12978             default:
12979                 probedelay = mDNSPlatformOneSecond / 2;
12980                 numannounce = InitialAnnounceCount;
12981                 break;
12982         }
12983 
12984         LogInfo("mDNS_RegisterInterface: %s (%#a) probedelay %d", set->ifname, &set->ip, probedelay);
12985 
12986         // No probe or sending suppression on DirectLink type interfaces.
12987         if (activationSpeed == FastActivation)
12988         {
12989             m->SuppressSending = 0;
12990             m->SuppressProbes = 0;
12991         }
12992         else
12993         {
12994 	        // Use a small amount of randomness:
12995 	        // In the case of a network administrator turning on an Ethernet hub so that all the
12996 	        // connected machines establish link at exactly the same time, we don't want them all
12997 	        // to go and hit the network with identical queries at exactly the same moment.
12998 	        // We set a random delay of up to InitialQuestionInterval (1/3 second).
12999 	        // We must *never* set m->SuppressSending to more than that (or set it repeatedly in a way
13000 	        // that causes mDNSResponder to remain in a prolonged state of SuppressSending, because
13001 	        // suppressing packet sending for more than about 1/3 second can cause protocol correctness
13002 	        // to start to break down (e.g. we don't answer probes fast enough, and get name conflicts).
13003 	        // See <rdar://problem/4073853> mDNS: m->SuppressSending set too enthusiastically
13004             if (!m->SuppressSending) m->SuppressSending = m->timenow + (mDNSs32)mDNSRandom((mDNSu32)InitialQuestionInterval);
13005 
13006             if (m->SuppressProbes == 0 ||
13007                 m->SuppressProbes - NonZeroTime(m->timenow + probedelay) < 0)
13008                 m->SuppressProbes = NonZeroTime(m->timenow + probedelay);
13009         }
13010 
13011         // Include OWNER option in packets for 60 seconds after connecting to the network. Setting
13012         // it here also handles the wake up case as the network link comes UP after waking causing
13013         // us to reconnect to the network. If we do this as part of the wake up code, it is possible
13014         // that the network link comes UP after 60 seconds and we never set the OWNER option
13015         m->AnnounceOwner = NonZeroTime(m->timenow + 60 * mDNSPlatformOneSecond);
13016         LogInfo("mDNS_RegisterInterface: Setting AnnounceOwner");
13017 
13018         m->mDNSStats.InterfaceUp++;
13019         for (q = m->Questions; q; q=q->next)                                // Scan our list of questions
13020         {
13021             if (mDNSOpaque16IsZero(q->TargetQID))
13022             {
13023                 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID)      // If non-specific Q, or Q on this specific interface,
13024                 {                                                               // then reactivate this question
13025                     // If flapping, delay between first and second queries is nine seconds instead of one second
13026                     mDNSBool dodelay = (activationSpeed == SlowActivation) && (q->FlappingInterface1 == set->InterfaceID || q->FlappingInterface2 == set->InterfaceID);
13027                     mDNSs32 initial  = dodelay ? InitialQuestionInterval * QuestionIntervalStep2 : InitialQuestionInterval;
13028                     mDNSs32 qdelay   = dodelay ? kDefaultQueryDelayTimeForFlappingInterface : 0;
13029                     if (dodelay) LogInfo("No cache records expired for %##s (%s); delaying questions by %d seconds", q->qname.c, DNSTypeName(q->qtype), qdelay);
13030 
13031                     if (!q->ThisQInterval || q->ThisQInterval > initial)
13032                     {
13033                         q->ThisQInterval  = initial;
13034                         q->RequestUnicast = kDefaultRequestUnicastCount;
13035                     }
13036                     q->LastQTime = m->timenow - q->ThisQInterval + qdelay;
13037                     q->RecentAnswerPkts = 0;
13038                     // Change the salt
13039                     ReInitAnonInfo(&q->AnonInfo, &q->qname);
13040                     SetNextQueryTime(m,q);
13041                 }
13042             }
13043         }
13044 
13045         // For all our non-specific authoritative resource records (and any dormant records specific to this interface)
13046         // we now need them to re-probe if necessary, and then re-announce.
13047         for (rr = m->ResourceRecords; rr; rr=rr->next)
13048         {
13049             if (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == set->InterfaceID)
13050             {
13051                 // Change the salt
13052                 ReInitAnonInfo(&rr->resrec.AnonInfo, rr->resrec.name);
13053                 mDNSCoreRestartRegistration(m, rr, numannounce);
13054             }
13055         }
13056 #if APPLE_OSX_mDNSResponder && !TARGET_OS_IPHONE
13057         DNSSECProbe(m);
13058 #endif
13059     }
13060 
13061     RestartRecordGetZoneData(m);
13062 
13063     mDNS_UpdateAllowSleep(m);
13064 
13065     mDNS_Unlock(m);
13066     return(mStatus_NoError);
13067 }
13068 
13069 // Note: mDNS_DeregisterInterface calls mDNS_Deregister_internal which can call a user callback, which may change
13070 // the record list and/or question list.
13071 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13072 mDNSexport void mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
13073 {
13074     NetworkInterfaceInfo **p = &m->HostInterfaces;
13075     mDNSBool revalidate = mDNSfalse;
13076     NetworkInterfaceInfo *primary;
13077     NetworkInterfaceInfo *intf;
13078     AuthRecord *A;
13079 
13080     mDNS_Lock(m);
13081 
13082     // Find this record in our list
13083     while (*p && *p != set) p=&(*p)->next;
13084     if (!*p) { debugf("mDNS_DeregisterInterface: NetworkInterfaceInfo not found in list"); mDNS_Unlock(m); return; }
13085 
13086     mDNS_DeactivateNetWake_internal(m, set);
13087 
13088     // Unlink this record from our list
13089     *p = (*p)->next;
13090     set->next = mDNSNULL;
13091 
13092     if (!set->InterfaceActive)
13093     {
13094         // If this interface not the active member of its set, update the v4/v6Available flags for the active member
13095         for (intf = m->HostInterfaces; intf; intf = intf->next)
13096             if (intf->InterfaceActive && intf->InterfaceID == set->InterfaceID)
13097                 UpdateInterfaceProtocols(m, intf);
13098     }
13099     else
13100     {
13101         intf = FirstInterfaceForID(m, set->InterfaceID);
13102         if (intf)
13103         {
13104             LogInfo("mDNS_DeregisterInterface: Another representative of InterfaceID %d %s (%#a) exists;"
13105                     " making it active", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13106             if (intf->InterfaceActive)
13107                 LogMsg("mDNS_DeregisterInterface: ERROR intf->InterfaceActive already set for %s (%#a)", set->ifname, &set->ip);
13108             intf->InterfaceActive = mDNStrue;
13109             UpdateInterfaceProtocols(m, intf);
13110 
13111             if (intf->NetWake) mDNS_ActivateNetWake_internal(m, intf);
13112 
13113             // See if another representative *of the same type* exists. If not, we mave have gone from
13114             // dual-stack to v6-only (or v4-only) so we need to reconfirm which records are still valid.
13115             for (intf = m->HostInterfaces; intf; intf = intf->next)
13116                 if (intf->InterfaceID == set->InterfaceID && intf->ip.type == set->ip.type)
13117                     break;
13118             if (!intf) revalidate = mDNStrue;
13119         }
13120         else
13121         {
13122             mDNSu32 slot;
13123             CacheGroup *cg;
13124             CacheRecord *rr;
13125             DNSQuestion *q;
13126 
13127             LogInfo("mDNS_DeregisterInterface: Last representative of InterfaceID %d %s (%#a) deregistered;"
13128                     " marking questions etc. dormant", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13129 
13130             m->mDNSStats.InterfaceDown++;
13131 
13132             if (set->McastTxRx && (activationSpeed == SlowActivation))
13133             {
13134                 LogMsg("mDNS_DeregisterInterface: Frequent transitions for interface %s (%#a)", set->ifname, &set->ip);
13135                 m->mDNSStats.InterfaceDownFlap++;
13136             }
13137 
13138             // 1. Deactivate any questions specific to this interface, and tag appropriate questions
13139             // so that mDNS_RegisterInterface() knows how swiftly it needs to reactivate them
13140             for (q = m->Questions; q; q=q->next)
13141             {
13142                 if (q->InterfaceID == set->InterfaceID) q->ThisQInterval = 0;
13143                 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID)
13144                 {
13145                     q->FlappingInterface2 = q->FlappingInterface1;
13146                     q->FlappingInterface1 = set->InterfaceID;       // Keep history of the last two interfaces to go away
13147                 }
13148             }
13149 
13150             // 2. Flush any cache records received on this interface
13151             revalidate = mDNSfalse;     // Don't revalidate if we're flushing the records
13152             FORALL_CACHERECORDS(slot, cg, rr)
13153             {
13154                 if (rr->resrec.InterfaceID == set->InterfaceID)
13155                 {
13156                     // If this interface is deemed flapping,
13157                     // postpone deleting the cache records in case the interface comes back again
13158                     if (set->McastTxRx && (activationSpeed == SlowActivation))
13159                     {
13160                         // For a flapping interface we want these records to go away after
13161                         // kDefaultReconfirmTimeForFlappingInterface seconds if they are not reconfirmed.
13162                         mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13163                         // We set UnansweredQueries = MaxUnansweredQueries so we don't waste time doing any queries for them --
13164                         // if the interface does come back, any relevant questions will be reactivated anyway
13165                         rr->UnansweredQueries = MaxUnansweredQueries;
13166                     }
13167                     else
13168                     {
13169                         mDNS_PurgeCacheResourceRecord(m, rr);
13170                     }
13171                 }
13172             }
13173         }
13174     }
13175 
13176     // If we still have address records referring to this one, update them.
13177     // This is safe, because this NetworkInterfaceInfo has already been unlinked from the list,
13178     // so the call to FindFirstAdvertisedInterface() won’t accidentally find it.
13179     primary = FindFirstAdvertisedInterface(m);
13180     A = primary ? &primary->RR_A : mDNSNULL;
13181     for (intf = m->HostInterfaces; intf; intf = intf->next)
13182         if (intf->RR_A.RRSet == &set->RR_A)
13183             intf->RR_A.RRSet = A;
13184 
13185     // If we were advertising on this interface, deregister those address and reverse-lookup records now
13186     if (set->Advertise) DeadvertiseInterface(m, set);
13187 
13188     // If we have any cache records received on this interface that went away, then re-verify them.
13189     // In some versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
13190     // giving the false impression that there's an active representative of this interface when there really isn't.
13191     // Don't need to do this when shutting down, because *all* interfaces are about to go away
13192     if (revalidate && !m->ShutdownTime)
13193     {
13194         mDNSu32 slot;
13195         CacheGroup *cg;
13196         CacheRecord *rr;
13197         FORALL_CACHERECORDS(slot, cg, rr)
13198         if (rr->resrec.InterfaceID == set->InterfaceID)
13199             mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13200     }
13201 
13202     mDNS_UpdateAllowSleep(m);
13203 
13204     mDNS_Unlock(m);
13205 }
13206 
13207 mDNSlocal void SetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13208 {
13209     int i, len;
13210 
13211     if (!sr->AnonData)
13212         return;
13213 
13214     len = mDNSPlatformStrLen(sr->AnonData);
13215     if (sr->RR_PTR.resrec.AnonInfo)
13216     {
13217         LogMsg("SetAnonInfoSRS: Freeing AnonInfo for PTR record %##s, should have been freed already", sr->RR_PTR.resrec.name->c);
13218         FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13219     }
13220     sr->RR_PTR.resrec.AnonInfo = AllocateAnonInfo(sr->RR_PTR.resrec.name, sr->AnonData, len, mDNSNULL);
13221     for (i=0; i<NumSubTypes; i++)
13222     {
13223         if (sr->SubTypes[i].resrec.AnonInfo)
13224         {
13225             LogMsg("SetAnonInfoSRS: Freeing AnonInfo for subtype record %##s, should have been freed already", sr->SubTypes[i].resrec.name->c);
13226             FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13227         }
13228         sr->SubTypes[i].resrec.AnonInfo = AllocateAnonInfo(sr->SubTypes[i].resrec.name, sr->AnonData, len, mDNSNULL);
13229     }
13230 }
13231 
13232 mDNSlocal void ResetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13233 {
13234     int i;
13235 
13236     if (!sr->AnonData)
13237         return;
13238     if (sr->RR_PTR.resrec.AnonInfo)
13239     {
13240         FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13241         sr->RR_PTR.resrec.AnonInfo = mDNSNULL;
13242     }
13243     for (i=0; i<NumSubTypes; i++)
13244     {
13245         if (sr->SubTypes[i].resrec.AnonInfo)
13246         {
13247             FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13248             sr->SubTypes[i].resrec.AnonInfo = mDNSNULL;
13249         }
13250     }
13251 }
13252 
13253 mDNSlocal void ServiceCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13254 {
13255     ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13256     (void)m;    // Unused parameter
13257 
13258     #if MDNS_DEBUGMSGS
13259     {
13260         char *msg = "Unknown result";
13261         if      (result == mStatus_NoError) msg = "Name Registered";
13262         else if (result == mStatus_NameConflict) msg = "Name Conflict";
13263         else if (result == mStatus_MemFree) msg = "Memory Free";
13264         debugf("ServiceCallback: %##s (%s) %s (%d)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
13265     }
13266     #endif
13267 
13268     // Only pass on the NoError acknowledgement for the SRV record (when it finishes probing)
13269     if (result == mStatus_NoError && rr != &sr->RR_SRV) return;
13270 
13271     // If we got a name conflict on either SRV or TXT, forcibly deregister this service, and record that we did that
13272     if (result == mStatus_NameConflict)
13273     {
13274         sr->Conflict = mDNStrue;                // Record that this service set had a conflict
13275         mDNS_DeregisterService(m, sr);          // Unlink the records from our list
13276         return;
13277     }
13278 
13279     if (result == mStatus_MemFree)
13280     {
13281         // If the SRV/TXT/PTR records, or the _services._dns-sd._udp record, or any of the subtype PTR records,
13282         // are still in the process of deregistering, don't pass on the NameConflict/MemFree message until
13283         // every record is finished cleaning up.
13284         mDNSu32 i;
13285         ExtraResourceRecord *e = sr->Extras;
13286 
13287         if (sr->RR_SRV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13288         if (sr->RR_TXT.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13289         if (sr->RR_PTR.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13290         if (sr->RR_ADV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13291         for (i=0; i<sr->NumSubTypes; i++) if (sr->SubTypes[i].resrec.RecordType != kDNSRecordTypeUnregistered) return;
13292 
13293         while (e)
13294         {
13295             if (e->r.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13296             e = e->next;
13297         }
13298         ResetAnonInfoSRS(sr, sr->NumSubTypes);
13299 
13300         // If this ServiceRecordSet was forcibly deregistered, and now its memory is ready for reuse,
13301         // then we can now report the NameConflict to the client
13302         if (sr->Conflict) result = mStatus_NameConflict;
13303 
13304     }
13305 
13306     LogInfo("ServiceCallback: All records %s for %##s", (result == mStatus_MemFree ? "Unregistered" : "Registered"), sr->RR_PTR.resrec.name->c);
13307     // CAUTION: MUST NOT do anything more with sr after calling sr->Callback(), because the client's callback
13308     // function is allowed to do anything, including deregistering this service and freeing its memory.
13309     if (sr->ServiceCallback)
13310         sr->ServiceCallback(m, sr, result);
13311 }
13312 
13313 mDNSlocal void NSSCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13314 {
13315     ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13316     if (sr->ServiceCallback)
13317         sr->ServiceCallback(m, sr, result);
13318 }
13319 
13320 
13321 // Derive AuthRecType from the kDNSServiceFlags* values.
13322 mDNSlocal AuthRecType setAuthRecType(mDNSInterfaceID InterfaceID, mDNSu32 flags)
13323 {
13324     AuthRecType artype;
13325 
13326     if (InterfaceID == mDNSInterface_LocalOnly)
13327         artype = AuthRecordLocalOnly;
13328     else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13329         artype = AuthRecordP2P;
13330     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P)
13331             && (flags & kDNSServiceFlagsIncludeAWDL))
13332         artype = AuthRecordAnyIncludeAWDLandP2P;
13333     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P))
13334         artype = AuthRecordAnyIncludeP2P;
13335     else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeAWDL))
13336         artype = AuthRecordAnyIncludeAWDL;
13337     else
13338         artype = AuthRecordAny;
13339 
13340     return artype;
13341 }
13342 
13343 // Used to derive the original D2D specific flags specified by the client in the registration
13344 // when we don't have access to the original flag (kDNSServiceFlags*) values.
13345 mDNSexport mDNSu32 deriveD2DFlagsFromAuthRecType(AuthRecType authRecType)
13346 {
13347     mDNSu32 flags = 0;
13348     if ((authRecType == AuthRecordAnyIncludeP2P) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13349         flags |= kDNSServiceFlagsIncludeP2P;
13350     else if ((authRecType == AuthRecordAnyIncludeAWDL) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13351         flags |= kDNSServiceFlagsIncludeAWDL;
13352     return flags;
13353 }
13354 
13355 // Note:
13356 // Name is first label of domain name (any dots in the name are actual dots, not label separators)
13357 // Type is service type (e.g. "_ipp._tcp.")
13358 // Domain is fully qualified domain name (i.e. ending with a null label)
13359 // We always register a TXT, even if it is empty (so that clients are not
13360 // left waiting forever looking for a nonexistent record.)
13361 // If the host parameter is mDNSNULL or the root domain (ASCII NUL),
13362 // then the default host name (m->MulticastHostname) is automatically used
13363 // If the optional target host parameter is set, then the storage it points to must remain valid for the lifetime of the service registration
13364 mDNSexport mStatus mDNS_RegisterService(mDNS *const m, ServiceRecordSet *sr,
13365                                         const domainlabel *const name, const domainname *const type, const domainname *const domain,
13366                                         const domainname *const host, mDNSIPPort port, const mDNSu8 txtinfo[], mDNSu16 txtlen,
13367                                         AuthRecord *SubTypes, mDNSu32 NumSubTypes,
13368                                         mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context, mDNSu32 flags)
13369 {
13370     mStatus err;
13371     mDNSu32 i;
13372     mDNSu32 hostTTL;
13373     AuthRecType artype;
13374     mDNSu8 recordType = (flags & kDNSServiceFlagsKnownUnique) ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique;
13375 
13376     sr->ServiceCallback = Callback;
13377     sr->ServiceContext  = Context;
13378     sr->Conflict        = mDNSfalse;
13379 
13380     sr->Extras          = mDNSNULL;
13381     sr->NumSubTypes     = NumSubTypes;
13382     sr->SubTypes        = SubTypes;
13383     sr->flags           = flags;
13384 
13385     artype = setAuthRecType(InterfaceID, flags);
13386 
13387     // Initialize the AuthRecord objects to sane values
13388     // Need to initialize everything correctly *before* making the decision whether to do a RegisterNoSuchService and bail out
13389     mDNS_SetupResourceRecord(&sr->RR_ADV, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeAdvisory, artype, ServiceCallback, sr);
13390     mDNS_SetupResourceRecord(&sr->RR_PTR, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared,   artype, ServiceCallback, sr);
13391 
13392     if (flags & kDNSServiceFlagsWakeOnlyService)
13393     {
13394         sr->RR_PTR.AuthFlags = AuthFlagsWakeOnly;
13395     }
13396 
13397     if (SameDomainName(type, (const domainname *) "\x4" "_ubd" "\x4" "_tcp"))
13398         hostTTL = kHostNameSmallTTL;
13399     else
13400         hostTTL = kHostNameTTL;
13401 
13402     mDNS_SetupResourceRecord(&sr->RR_SRV, mDNSNULL, InterfaceID, kDNSType_SRV, hostTTL, recordType, artype, ServiceCallback, sr);
13403     mDNS_SetupResourceRecord(&sr->RR_TXT, mDNSNULL, InterfaceID, kDNSType_TXT, kStandardTTL, recordType, artype, ServiceCallback, sr);
13404 
13405     // If port number is zero, that means the client is really trying to do a RegisterNoSuchService
13406     if (mDNSIPPortIsZero(port))
13407         return(mDNS_RegisterNoSuchService(m, &sr->RR_SRV, name, type, domain, mDNSNULL, InterfaceID, NSSCallback, sr, flags));
13408 
13409     // If the caller is registering an oversized TXT record,
13410     // it is the caller's responsibility to allocate a ServiceRecordSet structure that is large enough for it
13411     if (sr->RR_TXT.resrec.rdata->MaxRDLength < txtlen)
13412         sr->RR_TXT.resrec.rdata->MaxRDLength = txtlen;
13413 
13414     // Set up the record names
13415     // For now we only create an advisory record for the main type, not for subtypes
13416     // We need to gain some operational experience before we decide if there's a need to create them for subtypes too
13417     if (ConstructServiceName(&sr->RR_ADV.namestorage, (const domainlabel*)"\x09_services", (const domainname*)"\x07_dns-sd\x04_udp", domain) == mDNSNULL)
13418         return(mStatus_BadParamErr);
13419     if (ConstructServiceName(&sr->RR_PTR.namestorage, mDNSNULL, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13420     if (ConstructServiceName(&sr->RR_SRV.namestorage, name,     type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13421     AssignDomainName(&sr->RR_TXT.namestorage, sr->RR_SRV.resrec.name);
13422 
13423     // 1. Set up the ADV record rdata to advertise our service type
13424     AssignDomainName(&sr->RR_ADV.resrec.rdata->u.name, sr->RR_PTR.resrec.name);
13425 
13426     // 2. Set up the PTR record rdata to point to our service name
13427     // We set up two additionals, so when a client asks for this PTR we automatically send the SRV and the TXT too
13428     // Note: uDNS registration code assumes that Additional1 points to the SRV record
13429     AssignDomainName(&sr->RR_PTR.resrec.rdata->u.name, sr->RR_SRV.resrec.name);
13430     sr->RR_PTR.Additional1 = &sr->RR_SRV;
13431     sr->RR_PTR.Additional2 = &sr->RR_TXT;
13432 
13433     // 2a. Set up any subtype PTRs to point to our service name
13434     // If the client is using subtypes, it is the client's responsibility to have
13435     // already set the first label of the record name to the subtype being registered
13436     for (i=0; i<NumSubTypes; i++)
13437     {
13438         domainname st;
13439         AssignDomainName(&st, sr->SubTypes[i].resrec.name);
13440         st.c[1+st.c[0]] = 0;            // Only want the first label, not the whole FQDN (particularly for mDNS_RenameAndReregisterService())
13441         AppendDomainName(&st, type);
13442         mDNS_SetupResourceRecord(&sr->SubTypes[i], mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, ServiceCallback, sr);
13443         if (ConstructServiceName(&sr->SubTypes[i].namestorage, mDNSNULL, &st, domain) == mDNSNULL) return(mStatus_BadParamErr);
13444         AssignDomainName(&sr->SubTypes[i].resrec.rdata->u.name, &sr->RR_SRV.namestorage);
13445         sr->SubTypes[i].Additional1 = &sr->RR_SRV;
13446         sr->SubTypes[i].Additional2 = &sr->RR_TXT;
13447     }
13448 
13449     SetAnonInfoSRS(sr, NumSubTypes);
13450 
13451     // 3. Set up the SRV record rdata.
13452     sr->RR_SRV.resrec.rdata->u.srv.priority = 0;
13453     sr->RR_SRV.resrec.rdata->u.srv.weight   = 0;
13454     sr->RR_SRV.resrec.rdata->u.srv.port     = port;
13455 
13456     // Setting AutoTarget tells DNS that the target of this SRV is to be automatically kept in sync with our host name
13457     if (host && host->c[0]) AssignDomainName(&sr->RR_SRV.resrec.rdata->u.srv.target, host);
13458     else { sr->RR_SRV.AutoTarget = Target_AutoHost; sr->RR_SRV.resrec.rdata->u.srv.target.c[0] = '\0'; }
13459 
13460     // 4. Set up the TXT record rdata,
13461     // and set DependentOn because we're depending on the SRV record to find and resolve conflicts for us
13462     // Note: uDNS registration code assumes that DependentOn points to the SRV record
13463     if (txtinfo == mDNSNULL) sr->RR_TXT.resrec.rdlength = 0;
13464     else if (txtinfo != sr->RR_TXT.resrec.rdata->u.txt.c)
13465     {
13466         sr->RR_TXT.resrec.rdlength = txtlen;
13467         if (sr->RR_TXT.resrec.rdlength > sr->RR_TXT.resrec.rdata->MaxRDLength) return(mStatus_BadParamErr);
13468         mDNSPlatformMemCopy(sr->RR_TXT.resrec.rdata->u.txt.c, txtinfo, txtlen);
13469     }
13470     sr->RR_TXT.DependentOn = &sr->RR_SRV;
13471 
13472     mDNS_Lock(m);
13473     // It is important that we register SRV first. uDNS assumes that SRV is registered first so
13474     // that if the SRV cannot find a target, rest of the records that belong to this service
13475     // will not be activated.
13476     err = mDNS_Register_internal(m, &sr->RR_SRV);
13477     // If we can't register the SRV record due to errors, bail out. It has not been inserted in
13478     // any list and hence no need to deregister. We could probably do similar checks for other
13479     // records below and bail out. For now, this seems to be sufficient to address rdar://9304275
13480     if (err)
13481     {
13482         mDNS_Unlock(m);
13483         return err;
13484     }
13485     if (!err) err = mDNS_Register_internal(m, &sr->RR_TXT);
13486     // We register the RR_PTR last, because we want to be sure that in the event of a forced call to
13487     // mDNS_StartExit, the RR_PTR will be the last one to be forcibly deregistered, since that is what triggers
13488     // the mStatus_MemFree callback to ServiceCallback, which in turn passes on the mStatus_MemFree back to
13489     // the client callback, which is then at liberty to free the ServiceRecordSet memory at will. We need to
13490     // make sure we've deregistered all our records and done any other necessary cleanup before that happens.
13491     if (!err) err = mDNS_Register_internal(m, &sr->RR_ADV);
13492     for (i=0; i<NumSubTypes; i++) if (!err) err = mDNS_Register_internal(m, &sr->SubTypes[i]);
13493     if (!err) err = mDNS_Register_internal(m, &sr->RR_PTR);
13494 
13495     mDNS_Unlock(m);
13496 
13497     if (err) mDNS_DeregisterService(m, sr);
13498     return(err);
13499 }
13500 
13501 mDNSexport mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr,
13502                                            ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl,  mDNSu32 flags)
13503 {
13504     ExtraResourceRecord **e;
13505     mStatus status;
13506     AuthRecType artype;
13507     mDNSInterfaceID InterfaceID = sr->RR_PTR.resrec.InterfaceID;
13508     ResourceRecord *rr;
13509 
13510     artype = setAuthRecType(InterfaceID, flags);
13511 
13512     extra->next = mDNSNULL;
13513     mDNS_SetupResourceRecord(&extra->r, rdata, sr->RR_PTR.resrec.InterfaceID,
13514                              extra->r.resrec.rrtype, ttl, kDNSRecordTypeUnique, artype, ServiceCallback, sr);
13515     AssignDomainName(&extra->r.namestorage, sr->RR_SRV.resrec.name);
13516 
13517     mDNS_Lock(m);
13518     rr = mDNSNULL;
13519     if (extra->r.resrec.rrtype == kDNSType_TXT)
13520     {
13521         if (sr->RR_TXT.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_TXT.resrec;
13522     }
13523     else if (extra->r.resrec.rrtype == kDNSType_SRV)
13524     {
13525         if (sr->RR_SRV.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_SRV.resrec;
13526     }
13527 
13528     if (!rr)
13529     {
13530         ExtraResourceRecord *srExtra;
13531 
13532         for (srExtra = sr->Extras; srExtra; srExtra = srExtra->next)
13533         {
13534             if ((srExtra->r.resrec.rrtype == extra->r.resrec.rrtype) && (srExtra->r.resrec.RecordType & kDNSRecordTypeUniqueMask))
13535             {
13536                 rr = &srExtra->r.resrec;
13537                 break;
13538             }
13539         }
13540     }
13541 
13542     if (rr && (extra->r.resrec.rroriginalttl != rr->rroriginalttl))
13543     {
13544         LogMsg("mDNS_AddRecordToService: Correcting TTL from %4d to %4d for %s",
13545             extra->r.resrec.rroriginalttl, rr->rroriginalttl, RRDisplayString(m, &extra->r.resrec));
13546         extra->r.resrec.rroriginalttl = rr->rroriginalttl;
13547     }
13548 
13549     e = &sr->Extras;
13550     while (*e) e = &(*e)->next;
13551 
13552     extra->r.DependentOn = &sr->RR_SRV;
13553 
13554     debugf("mDNS_AddRecordToService adding record to %##s %s %d",
13555            extra->r.resrec.name->c, DNSTypeName(extra->r.resrec.rrtype), extra->r.resrec.rdlength);
13556 
13557     status = mDNS_Register_internal(m, &extra->r);
13558     if (status == mStatus_NoError) *e = extra;
13559 
13560     mDNS_Unlock(m);
13561     return(status);
13562 }
13563 
13564 mDNSexport mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra,
13565                                                 mDNSRecordCallback MemFreeCallback, void *Context)
13566 {
13567     ExtraResourceRecord **e;
13568     mStatus status;
13569 
13570     mDNS_Lock(m);
13571     e = &sr->Extras;
13572     while (*e && *e != extra) e = &(*e)->next;
13573     if (!*e)
13574     {
13575         debugf("mDNS_RemoveRecordFromService failed to remove record from %##s", extra->r.resrec.name->c);
13576         status = mStatus_BadReferenceErr;
13577     }
13578     else
13579     {
13580         debugf("mDNS_RemoveRecordFromService removing record from %##s", extra->r.resrec.name->c);
13581         extra->r.RecordCallback = MemFreeCallback;
13582         extra->r.RecordContext  = Context;
13583         *e = (*e)->next;
13584         status = mDNS_Deregister_internal(m, &extra->r, mDNS_Dereg_normal);
13585     }
13586     mDNS_Unlock(m);
13587     return(status);
13588 }
13589 
13590 mDNSexport mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname)
13591 {
13592     // Note: Don't need to use mDNS_Lock(m) here, because this code is just using public routines
13593     // mDNS_RegisterService() and mDNS_AddRecordToService(), which do the right locking internally.
13594     domainlabel name1, name2;
13595     domainname type, domain;
13596     const domainname *host = sr->RR_SRV.AutoTarget ? mDNSNULL : &sr->RR_SRV.resrec.rdata->u.srv.target;
13597     ExtraResourceRecord *extras = sr->Extras;
13598     mStatus err;
13599 
13600     DeconstructServiceName(sr->RR_SRV.resrec.name, &name1, &type, &domain);
13601     if (!newname)
13602     {
13603         name2 = name1;
13604         IncrementLabelSuffix(&name2, mDNStrue);
13605         newname = &name2;
13606     }
13607 
13608     if (SameDomainName(&domain, &localdomain))
13609         debugf("%##s service renamed from \"%#s\" to \"%#s\"", type.c, name1.c, newname->c);
13610     else debugf("%##s service (domain %##s) renamed from \"%#s\" to \"%#s\"",type.c, domain.c, name1.c, newname->c);
13611 
13612     err = mDNS_RegisterService(m, sr, newname, &type, &domain,
13613                                host, sr->RR_SRV.resrec.rdata->u.srv.port, sr->RR_TXT.resrec.rdata->u.txt.c, sr->RR_TXT.resrec.rdlength,
13614                                sr->SubTypes, sr->NumSubTypes,
13615                                sr->RR_PTR.resrec.InterfaceID, sr->ServiceCallback, sr->ServiceContext, sr->flags);
13616 
13617     // mDNS_RegisterService() just reset sr->Extras to NULL.
13618     // Fortunately we already grabbed ourselves a copy of this pointer (above), so we can now run
13619     // through the old list of extra records, and re-add them to our freshly created service registration
13620     while (!err && extras)
13621     {
13622         ExtraResourceRecord *e = extras;
13623         extras = extras->next;
13624         err = mDNS_AddRecordToService(m, sr, e, e->r.resrec.rdata, e->r.resrec.rroriginalttl, 0);
13625     }
13626 
13627     return(err);
13628 }
13629 
13630 // Note: mDNS_DeregisterService calls mDNS_Deregister_internal which can call a user callback,
13631 // which may change the record list and/or question list.
13632 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13633 mDNSexport mStatus mDNS_DeregisterService_drt(mDNS *const m, ServiceRecordSet *sr, mDNS_Dereg_type drt)
13634 {
13635     // If port number is zero, that means this was actually registered using mDNS_RegisterNoSuchService()
13636     if (mDNSIPPortIsZero(sr->RR_SRV.resrec.rdata->u.srv.port)) return(mDNS_DeregisterNoSuchService(m, &sr->RR_SRV));
13637 
13638     if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeUnregistered)
13639     {
13640         debugf("Service set for %##s already deregistered", sr->RR_SRV.resrec.name->c);
13641         return(mStatus_BadReferenceErr);
13642     }
13643     else if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeDeregistering)
13644     {
13645         LogInfo("Service set for %##s already in the process of deregistering", sr->RR_SRV.resrec.name->c);
13646         // Avoid race condition:
13647         // If a service gets a conflict, then we set the Conflict flag to tell us to generate
13648         // an mStatus_NameConflict message when we get the mStatus_MemFree for our PTR record.
13649         // If the client happens to deregister the service in the middle of that process, then
13650         // we clear the flag back to the normal state, so that we deliver a plain mStatus_MemFree
13651         // instead of incorrectly promoting it to mStatus_NameConflict.
13652         // This race condition is exposed particularly when the conformance test generates
13653         // a whole batch of simultaneous conflicts across a range of services all advertised
13654         // using the same system default name, and if we don't take this precaution then
13655         // we end up incrementing m->nicelabel multiple times instead of just once.
13656         // <rdar://problem/4060169> Bug when auto-renaming Computer Name after name collision
13657         sr->Conflict = mDNSfalse;
13658         return(mStatus_NoError);
13659     }
13660     else
13661     {
13662         mDNSu32 i;
13663         mStatus status;
13664         ExtraResourceRecord *e;
13665         mDNS_Lock(m);
13666         e = sr->Extras;
13667 
13668         // We use mDNS_Dereg_repeat because, in the event of a collision, some or all of the
13669         // SRV, TXT, or Extra records could have already been automatically deregistered, and that's okay
13670         mDNS_Deregister_internal(m, &sr->RR_SRV, mDNS_Dereg_repeat);
13671         mDNS_Deregister_internal(m, &sr->RR_TXT, mDNS_Dereg_repeat);
13672 
13673         mDNS_Deregister_internal(m, &sr->RR_ADV, drt);
13674 
13675         // We deregister all of the extra records, but we leave the sr->Extras list intact
13676         // in case the client wants to do a RenameAndReregister and reinstate the registration
13677         while (e)
13678         {
13679             mDNS_Deregister_internal(m, &e->r, mDNS_Dereg_repeat);
13680             e = e->next;
13681         }
13682 
13683         for (i=0; i<sr->NumSubTypes; i++)
13684             mDNS_Deregister_internal(m, &sr->SubTypes[i], drt);
13685 
13686         status = mDNS_Deregister_internal(m, &sr->RR_PTR, drt);
13687         mDNS_Unlock(m);
13688         return(status);
13689     }
13690 }
13691 
13692 // Create a registration that asserts that no such service exists with this name.
13693 // This can be useful where there is a given function is available through several protocols.
13694 // For example, a printer called "Stuart's Printer" may implement printing via the "pdl-datastream" and "IPP"
13695 // protocols, but not via "LPR". In this case it would be prudent for the printer to assert the non-existence of an
13696 // "LPR" service called "Stuart's Printer". Without this precaution, another printer than offers only "LPR" printing
13697 // could inadvertently advertise its service under the same name "Stuart's Printer", which might be confusing for users.
13698 mDNSexport mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr,
13699                                               const domainlabel *const name, const domainname *const type, const domainname *const domain,
13700                                               const domainname *const host,
13701                                               const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context, mDNSu32 flags)
13702 {
13703     AuthRecType artype;
13704 
13705     artype = setAuthRecType(InterfaceID, flags);
13706 
13707     mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_SRV, kHostNameTTL, kDNSRecordTypeUnique, artype, Callback, Context);
13708     if (ConstructServiceName(&rr->namestorage, name, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13709     rr->resrec.rdata->u.srv.priority    = 0;
13710     rr->resrec.rdata->u.srv.weight      = 0;
13711     rr->resrec.rdata->u.srv.port        = zeroIPPort;
13712     if (host && host->c[0]) AssignDomainName(&rr->resrec.rdata->u.srv.target, host);
13713     else rr->AutoTarget = Target_AutoHost;
13714     return(mDNS_Register(m, rr));
13715 }
13716 
13717 mDNSexport mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr,
13718                                          mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname)
13719 {
13720     AuthRecType artype;
13721 
13722     if (InterfaceID == mDNSInterface_LocalOnly)
13723         artype = AuthRecordLocalOnly;
13724     else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13725         artype = AuthRecordP2P;
13726     else
13727         artype = AuthRecordAny;
13728     mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, mDNSNULL, mDNSNULL);
13729     if (!MakeDomainNameFromDNSNameString(&rr->namestorage, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
13730     if (!MakeDomainNameFromDNSNameString(&rr->resrec.rdata->u.name, domname)) return(mStatus_BadParamErr);
13731     return(mDNS_Register(m, rr));
13732 }
13733 
13734 mDNSlocal mDNSBool mDNS_IdUsedInResourceRecordsList(mDNS * const m, mDNSOpaque16 id)
13735 {
13736     AuthRecord *r;
13737     for (r = m->ResourceRecords; r; r=r->next) if (mDNSSameOpaque16(id, r->updateid)) return mDNStrue;
13738     return mDNSfalse;
13739 }
13740 
13741 mDNSlocal mDNSBool mDNS_IdUsedInQuestionsList(mDNS * const m, mDNSOpaque16 id)
13742 {
13743     DNSQuestion *q;
13744     for (q = m->Questions; q; q=q->next) if (mDNSSameOpaque16(id, q->TargetQID)) return mDNStrue;
13745     return mDNSfalse;
13746 }
13747 
13748 mDNSexport mDNSOpaque16 mDNS_NewMessageID(mDNS * const m)
13749 {
13750     mDNSOpaque16 id;
13751     int i;
13752 
13753     for (i=0; i<10; i++)
13754     {
13755         id = mDNSOpaque16fromIntVal(1 + (mDNSu16)mDNSRandom(0xFFFE));
13756         if (!mDNS_IdUsedInResourceRecordsList(m, id) && !mDNS_IdUsedInQuestionsList(m, id)) break;
13757     }
13758 
13759     debugf("mDNS_NewMessageID: %5d", mDNSVal16(id));
13760 
13761     return id;
13762 }
13763 
13764 // ***************************************************************************
13765 #if COMPILER_LIKES_PRAGMA_MARK
13766 #pragma mark -
13767 #pragma mark - Sleep Proxy Server
13768 #endif
13769 
13770 mDNSlocal void RestartARPProbing(mDNS *const m, AuthRecord *const rr)
13771 {
13772     // If we see an ARP from a machine we think is sleeping, then either
13773     // (i) the machine has woken, or
13774     // (ii) it's just a stray old packet from before the machine slept
13775     // To handle the second case, we reset ProbeCount, so we'll suppress our own answers for a while, to avoid
13776     // generating ARP conflicts with a waking machine, and set rr->LastAPTime so we'll start probing again in 10 seconds.
13777     // If the machine has just woken then we'll discard our records when we see the first new mDNS probe from that machine.
13778     // 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*
13779     // need to send new ARP Announcements, because the owner's ARP broadcasts will have updated neighboring ARP caches, so we need to
13780     // re-assert our (temporary) ownership of that IP address in order to receive subsequent packets addressed to that IPv4 address.
13781 
13782     rr->resrec.RecordType = kDNSRecordTypeUnique;
13783     rr->ProbeCount        = DefaultProbeCountForTypeUnique;
13784     rr->ProbeRestartCount++;
13785 
13786     // If we haven't started announcing yet (and we're not already in ten-second-delay mode) the machine is probably
13787     // still going to sleep, so we just reset rr->ProbeCount so we'll continue probing until it stops responding.
13788     // If we *have* started announcing, the machine is probably in the process of waking back up, so in that case
13789     // we're more cautious and we wait ten seconds before probing it again. We do this because while waking from
13790     // sleep, some network interfaces tend to lose or delay inbound packets, and without this delay, if the waking machine
13791     // didn't answer our three probes within three seconds then we'd announce and cause it an unnecessary address conflict.
13792     if (rr->AnnounceCount == InitialAnnounceCount && m->timenow - rr->LastAPTime >= 0)
13793         InitializeLastAPTime(m, rr);
13794     else
13795     {
13796         rr->AnnounceCount  = InitialAnnounceCount;
13797         rr->ThisAPInterval = mDNSPlatformOneSecond;
13798         rr->LastAPTime     = m->timenow + mDNSPlatformOneSecond * 9;    // Send first packet at rr->LastAPTime + rr->ThisAPInterval, i.e. 10 seconds from now
13799         SetNextAnnounceProbeTime(m, rr);
13800     }
13801 }
13802 
13803 mDNSlocal void mDNSCoreReceiveRawARP(mDNS *const m, const ARP_EthIP *const arp, const mDNSInterfaceID InterfaceID)
13804 {
13805     static const mDNSOpaque16 ARP_op_request = { { 0, 1 } };
13806     AuthRecord *rr;
13807     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
13808     if (!intf) return;
13809 
13810     mDNS_Lock(m);
13811 
13812     // Pass 1:
13813     // Process ARP Requests and Probes (but not Announcements), and generate an ARP Reply if necessary.
13814     // We also process ARPs from our own kernel (and 'answer' them by injecting a local ARP table entry)
13815     // We ignore ARP Announcements here -- Announcements are not questions, they're assertions, so we don't need to answer them.
13816     // The times we might need to react to an ARP Announcement are:
13817     // (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
13818     // (ii) if it's a conflicting Announcement from another host
13819     // -- and we check for these in Pass 2 below.
13820     if (mDNSSameOpaque16(arp->op, ARP_op_request) && !mDNSSameIPv4Address(arp->spa, arp->tpa))
13821     {
13822         for (rr = m->ResourceRecords; rr; rr=rr->next)
13823             if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13824                 rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->tpa))
13825             {
13826                 static const char msg1[] = "ARP Req from owner -- re-probing";
13827                 static const char msg2[] = "Ignoring  ARP Request from      ";
13828                 static const char msg3[] = "Creating Local ARP Cache entry  ";
13829                 static const char msg4[] = "Answering ARP Request from      ";
13830                 const char *const msg = mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC) ? msg1 :
13831                                         (rr->AnnounceCount == InitialAnnounceCount)     ? msg2 :
13832                                         mDNSSameEthAddress(&arp->sha, &intf->MAC)       ? msg3 : msg4;
13833                 LogMsg("Arp %-7s %s %.6a %.4a for %.4a -- H-MAC %.6a I-MAC %.6a %s",
13834                        intf->ifname, msg, arp->sha.b, arp->spa.b, arp->tpa.b,
13835                        &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13836                 if (msg == msg1)
13837                 {
13838                     if ( rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
13839                         RestartARPProbing(m, rr);
13840                     else
13841                         LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
13842                 }
13843                 else if (msg == msg3)
13844                 {
13845                     mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
13846                 }
13847                 else if (msg == msg4)
13848                 {
13849                     SendARP(m, 2, rr, (mDNSv4Addr *)arp->tpa.b, &arp->sha, (mDNSv4Addr *)arp->spa.b, &arp->sha);
13850                 }
13851             }
13852     }
13853 
13854     // Pass 2:
13855     // 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.
13856     // (Strictly speaking we're only checking Announcement/Request/Reply packets, since ARP Probes have zero Sender IP address,
13857     // so by definition (and by design) they can never conflict with any real (i.e. non-zero) IP address).
13858     // 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.
13859     // If we see an apparently conflicting ARP, we check the sender hardware address:
13860     //   If the sender hardware address is the original owner this is benign, so we just suppress our own proxy answering for a while longer.
13861     //   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.
13862     if (mDNSSameEthAddress(&arp->sha, &intf->MAC))
13863         debugf("ARP from self for %.4a", arp->tpa.b);
13864     else
13865     {
13866         if (!mDNSSameIPv4Address(arp->spa, zerov4Addr))
13867             for (rr = m->ResourceRecords; rr; rr=rr->next)
13868                 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13869                     rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
13870                 {
13871                     if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
13872                     {
13873                         LogMsg("%-7s ARP from %.6a %.4a for %.4a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13874                                 arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13875                     }
13876                     else
13877                     {
13878                         RestartARPProbing(m, rr);
13879                         if (mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC))
13880                         {
13881                             LogMsg("%-7s ARP %s from owner %.6a %.4a for %-15.4a -- re-starting probing for %s", intf->ifname,
13882                                     mDNSSameIPv4Address(arp->spa, arp->tpa) ? "Announcement " : mDNSSameOpaque16(arp->op, ARP_op_request) ? "Request      " : "Response     ",
13883                                     arp->sha.b, arp->spa.b, arp->tpa.b, ARDisplayString(m, rr));
13884                         }
13885                         else
13886                         {
13887                             LogMsg("%-7s Conflicting ARP from %.6a %.4a for %.4a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13888                                     arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13889                             ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
13890                         }
13891                     }
13892                 }
13893     }
13894 
13895     mDNS_Unlock(m);
13896 }
13897 
13898 /*
13899    // Option 1 is Source Link Layer Address Option
13900    // Option 2 is Target Link Layer Address Option
13901    mDNSlocal const mDNSEthAddr *GetLinkLayerAddressOption(const IPv6NDP *const ndp, const mDNSu8 *const end, mDNSu8 op)
13902     {
13903     const mDNSu8 *options = (mDNSu8 *)(ndp+1);
13904     while (options < end)
13905         {
13906         debugf("NDP Option %02X len %2d %d", options[0], options[1], end - options);
13907         if (options[0] == op && options[1] == 1) return (const mDNSEthAddr*)(options+2);
13908         options += options[1] * 8;
13909         }
13910     return mDNSNULL;
13911     }
13912  */
13913 
13914 mDNSlocal void mDNSCoreReceiveRawND(mDNS *const m, const mDNSEthAddr *const sha, const mDNSv6Addr *spa,
13915                                     const IPv6NDP *const ndp, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
13916 {
13917     AuthRecord *rr;
13918     NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
13919     if (!intf) return;
13920 
13921     mDNS_Lock(m);
13922 
13923     // Pass 1: Process Neighbor Solicitations, and generate a Neighbor Advertisement if necessary.
13924     if (ndp->type == NDP_Sol)
13925     {
13926         //const mDNSEthAddr *const sha = GetLinkLayerAddressOption(ndp, end, NDP_SrcLL);
13927         (void)end;
13928         for (rr = m->ResourceRecords; rr; rr=rr->next)
13929             if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13930                 rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, ndp->target))
13931             {
13932                 static const char msg1[] = "NDP Req from owner -- re-probing";
13933                 static const char msg2[] = "Ignoring  NDP Request from      ";
13934                 static const char msg3[] = "Creating Local NDP Cache entry  ";
13935                 static const char msg4[] = "Answering NDP Request from      ";
13936                 static const char msg5[] = "Answering NDP Probe   from      ";
13937                 const char *const msg = sha && mDNSSameEthAddress(sha, &rr->WakeUp.IMAC) ? msg1 :
13938                                         (rr->AnnounceCount == InitialAnnounceCount)      ? msg2 :
13939                                         sha && mDNSSameEthAddress(sha, &intf->MAC)       ? msg3 :
13940                                         spa && mDNSIPv6AddressIsZero(*spa)               ? msg4 : msg5;
13941                 LogSPS("%-7s %s %.6a %.16a for %.16a -- H-MAC %.6a I-MAC %.6a %s",
13942                        intf->ifname, msg, sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13943                 if (msg == msg1)
13944                 {
13945                     if (rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
13946                         RestartARPProbing(m, rr);
13947                     else
13948                         LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
13949                 }
13950                 else if (msg == msg3)
13951                     mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
13952                 else if (msg == msg4)
13953                     SendNDP(m, NDP_Adv, NDP_Solicited, rr, &ndp->target, mDNSNULL, spa, sha);
13954                 else if (msg == msg5)
13955                     SendNDP(m, NDP_Adv, 0, rr, &ndp->target, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
13956             }
13957     }
13958 
13959     // 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.
13960     if (mDNSSameEthAddress(sha, &intf->MAC))
13961         debugf("NDP from self for %.16a", &ndp->target);
13962     else
13963     {
13964         // For Neighbor Advertisements we check the Target address field, not the actual IPv6 source address.
13965         // When a machine has both link-local and routable IPv6 addresses, it may send NDP packets making assertions
13966         // about its routable IPv6 address, using its link-local address as the source address for all NDP packets.
13967         // Hence it is the NDP target address we care about, not the actual packet source address.
13968         if (ndp->type == NDP_Adv) spa = &ndp->target;
13969         if (!mDNSSameIPv6Address(*spa, zerov6Addr))
13970             for (rr = m->ResourceRecords; rr; rr=rr->next)
13971                 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13972                     rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, *spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
13973                 {
13974                     if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
13975                     {
13976                         LogSPS("%-7s NDP from %.6a %.16a for %.16a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13977                                     sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13978                     }
13979                     else
13980                     {
13981                         RestartARPProbing(m, rr);
13982                         if (mDNSSameEthAddress(sha, &rr->WakeUp.IMAC))
13983                         {
13984                             LogSPS("%-7s NDP %s from owner %.6a %.16a for %.16a -- re-starting probing for %s", intf->ifname,
13985                                     ndp->type == NDP_Sol ? "Solicitation " : "Advertisement", sha, spa, &ndp->target, ARDisplayString(m, rr));
13986                         }
13987                         else
13988                         {
13989                             LogMsg("%-7s Conflicting NDP from %.6a %.16a for %.16a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13990                                     sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13991                             ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
13992                         }
13993                     }
13994                 }
13995     }
13996 
13997     mDNS_Unlock(m);
13998 }
13999 
14000 mDNSlocal void mDNSCoreReceiveRawTransportPacket(mDNS *const m, const mDNSEthAddr *const sha, const mDNSAddr *const src, const mDNSAddr *const dst, const mDNSu8 protocol,
14001                                                  const mDNSu8 *const p, const TransportLayerPacket *const t, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID, const mDNSu16 len)
14002 {
14003     const mDNSIPPort port = (protocol == 0x06) ? t->tcp.dst : (protocol == 0x11) ? t->udp.dst : zeroIPPort;
14004     mDNSBool wake = mDNSfalse;
14005     mDNSBool kaWake = mDNSfalse;
14006 
14007     switch (protocol)
14008     {
14009         #define XX wake ? "Received" : "Ignoring", end-p
14010     case 0x01:  LogSPS("Ignoring %d-byte ICMP from %#a to %#a", end-p, src, dst);
14011         break;
14012 
14013     case 0x06:  {
14014         AuthRecord *kr;
14015         mDNSu32 seq, ack;
14016                     #define TH_FIN  0x01
14017                     #define TH_SYN  0x02
14018                     #define TH_RST  0x04
14019                     #define TH_ACK  0x10
14020 
14021         kr = mDNS_MatchKeepaliveInfo(m, dst, src, port, t->tcp.src, &seq, &ack);
14022         if (kr)
14023         {
14024             LogSPS("mDNSCoreReceiveRawTransportPacket: Found a Keepalive record from %#a:%d  to %#a:%d", src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port));
14025             // Plan to wake if
14026             // (a) RST or FIN is set (the keepalive that we sent could have caused a reset)
14027             // (b) packet that contains new data and acks a sequence number higher than the one
14028             //     we have been sending in the keepalive
14029 
14030             wake = ((t->tcp.flags & TH_RST) || (t->tcp.flags & TH_FIN)) ;
14031             if (!wake)
14032             {
14033                 mDNSu8 *ptr;
14034                 mDNSu32 pseq, pack;
14035                 mDNSBool data = mDNSfalse;
14036                 mDNSu8 tcphlen;
14037 
14038                 // Convert to host order
14039                 ptr = (mDNSu8 *)&seq;
14040                 seq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14041 
14042                 ptr = (mDNSu8 *)&ack;
14043                 ack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14044 
14045                 pseq = t->tcp.seq;
14046                 ptr = (mDNSu8 *)&pseq;
14047                 pseq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14048 
14049                 pack = t->tcp.ack;
14050                 ptr = (mDNSu8 *)&pack;
14051                 pack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14052 
14053                 // If the other side is acking one more than our sequence number (keepalive is one
14054                 // less than the last valid sequence sent) and it's sequence is more than what we
14055                 // acked before
14056                 //if (end - p - 34  - ((t->tcp.offset >> 4) * 4) > 0) data = mDNStrue;
14057                 tcphlen = ((t->tcp.offset >> 4) * 4);
14058                 if (end - ((mDNSu8 *)t + tcphlen) > 0) data = mDNStrue;
14059                 wake = ((int)(pack - seq) > 0) && ((int)(pseq - ack) >= 0) && data;
14060 
14061                 // If we got a regular keepalive on a connection that was registed with the KeepAlive API, respond with an ACK
14062                 if ((t->tcp.flags & TH_ACK) && (data == mDNSfalse) &&
14063                     ((int)(ack - pseq) == 1))
14064                 {
14065                     // Send an ACK;
14066                     mDNS_SendKeepaliveACK(m, kr);
14067                 }
14068                 LogSPS("mDNSCoreReceiveRawTransportPacket: End %p, hlen %d, Datalen %d, pack %u, seq %u, pseq %u, ack %u, wake %d",
14069                        end, tcphlen, end - ((mDNSu8 *)t + tcphlen), pack, seq, pseq, ack, wake);
14070             }
14071             else { LogSPS("mDNSCoreReceiveRawTransportPacket: waking because of RST or FIN th_flags %d", t->tcp.flags); }
14072             kaWake = wake;
14073         }
14074         else
14075         {
14076             // Plan to wake if
14077             // (a) RST is not set, AND
14078             // (b) packet is SYN, SYN+FIN, or plain data packet (no SYN or FIN). We won't wake for FIN alone.
14079             wake = (!(t->tcp.flags & TH_RST) && (t->tcp.flags & (TH_FIN|TH_SYN)) != TH_FIN);
14080 
14081             // For now, to reduce spurious wakeups, we wake only for TCP SYN,
14082             // except for ssh connections, where we'll wake for plain data packets too
14083             if  (!mDNSSameIPPort(port, SSHPort) && !(t->tcp.flags & 2)) wake = mDNSfalse;
14084 
14085             LogSPS("%s %d-byte TCP from %#a:%d to %#a:%d%s%s%s", XX,
14086                    src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port),
14087                    (t->tcp.flags & 2) ? " SYN" : "",
14088                    (t->tcp.flags & 1) ? " FIN" : "",
14089                    (t->tcp.flags & 4) ? " RST" : "");
14090         }
14091         break;
14092     }
14093 
14094     case 0x11:  {
14095                     #define ARD_AsNumber 3283
14096         static const mDNSIPPort ARD = { { ARD_AsNumber >> 8, ARD_AsNumber & 0xFF } };
14097         const mDNSu16 udplen = (mDNSu16)((mDNSu16)t->bytes[4] << 8 | t->bytes[5]);                  // Length *including* 8-byte UDP header
14098         if (udplen >= sizeof(UDPHeader))
14099         {
14100             const mDNSu16 datalen = udplen - sizeof(UDPHeader);
14101             wake = mDNStrue;
14102 
14103             // For Back to My Mac UDP port 4500 (IPSEC) packets, we do some special handling
14104             if (mDNSSameIPPort(port, IPSECPort))
14105             {
14106                 // Specifically ignore NAT keepalive packets
14107                 if (datalen == 1 && end >= &t->bytes[9] && t->bytes[8] == 0xFF) wake = mDNSfalse;
14108                 else
14109                 {
14110                     // Skip over the Non-ESP Marker if present
14111                     const mDNSBool NonESP = (end >= &t->bytes[12] && t->bytes[8] == 0 && t->bytes[9] == 0 && t->bytes[10] == 0 && t->bytes[11] == 0);
14112                     const IKEHeader *const ike    = (IKEHeader *)(t + (NonESP ? 12 : 8));
14113                     const mDNSu16 ikelen = datalen - (NonESP ? 4 : 0);
14114                     if (ikelen >= sizeof(IKEHeader) && end >= ((mDNSu8 *)ike) + sizeof(IKEHeader))
14115                         if ((ike->Version & 0x10) == 0x10)
14116                         {
14117                             // ExchangeType ==  5 means 'Informational' <http://www.ietf.org/rfc/rfc2408.txt>
14118                             // ExchangeType == 34 means 'IKE_SA_INIT'   <http://www.iana.org/assignments/ikev2-parameters>
14119                             if (ike->ExchangeType == 5 || ike->ExchangeType == 34) wake = mDNSfalse;
14120                             LogSPS("%s %d-byte IKE ExchangeType %d", XX, ike->ExchangeType);
14121                         }
14122                 }
14123             }
14124 
14125             // For now, because we haven't yet worked out a clean elegant way to do this, we just special-case the
14126             // Apple Remote Desktop port number -- we ignore all packets to UDP 3283 (the "Net Assistant" port),
14127             // except for Apple Remote Desktop's explicit manual wakeup packet, which looks like this:
14128             // UDP header (8 bytes)
14129             // Payload: 13 88 00 6a 41 4e 41 20 (8 bytes) ffffffffffff (6 bytes) 16xMAC (96 bytes) = 110 bytes total
14130             if (mDNSSameIPPort(port, ARD)) wake = (datalen >= 110 && end >= &t->bytes[10] && t->bytes[8] == 0x13 && t->bytes[9] == 0x88);
14131 
14132             LogSPS("%s %d-byte UDP from %#a:%d to %#a:%d", XX, src, mDNSVal16(t->udp.src), dst, mDNSVal16(port));
14133         }
14134     }
14135     break;
14136 
14137     case 0x3A:  if (&t->bytes[len] <= end)
14138         {
14139             mDNSu16 checksum = IPv6CheckSum(&src->ip.v6, &dst->ip.v6, protocol, t->bytes, len);
14140             if (!checksum) mDNSCoreReceiveRawND(m, sha, &src->ip.v6, &t->ndp, &t->bytes[len], InterfaceID);
14141             else LogInfo("IPv6CheckSum bad %04X %02X%02X from %#a to %#a", checksum, t->bytes[2], t->bytes[3], src, dst);
14142         }
14143         break;
14144 
14145     default:    LogSPS("Ignoring %d-byte IP packet unknown protocol %d from %#a to %#a", end-p, protocol, src, dst);
14146         break;
14147     }
14148 
14149     if (wake)
14150     {
14151         AuthRecord *rr, *r2;
14152 
14153         mDNS_Lock(m);
14154         for (rr = m->ResourceRecords; rr; rr=rr->next)
14155             if (rr->resrec.InterfaceID == InterfaceID &&
14156                 rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14157                 rr->AddressProxy.type && mDNSSameAddress(&rr->AddressProxy, dst))
14158             {
14159                 const mDNSu8 *const tp = (protocol == 6) ? (const mDNSu8 *)"\x4_tcp" : (const mDNSu8 *)"\x4_udp";
14160                 for (r2 = m->ResourceRecords; r2; r2=r2->next)
14161                     if (r2->resrec.InterfaceID == InterfaceID && mDNSSameEthAddress(&r2->WakeUp.HMAC, &rr->WakeUp.HMAC) &&
14162                         r2->resrec.RecordType != kDNSRecordTypeDeregistering &&
14163                         r2->resrec.rrtype == kDNSType_SRV && mDNSSameIPPort(r2->resrec.rdata->u.srv.port, port) &&
14164                         SameDomainLabel(ThirdLabel(r2->resrec.name)->c, tp))
14165                         break;
14166                 if (!r2 && mDNSSameIPPort(port, IPSECPort)) r2 = rr;    // So that we wake for BTMM IPSEC packets, even without a matching SRV record
14167                 if (!r2 && kaWake) r2 = rr;                             // So that we wake for keepalive packets, even without a matching SRV record
14168                 if (r2)
14169                 {
14170                     LogMsg("Waking host at %s %#a H-MAC %.6a I-MAC %.6a for %s",
14171                            InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, r2));
14172                     ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14173                 }
14174                 else
14175                     LogSPS("Sleeping host at %s %#a %.6a has no service on %#s %d",
14176                            InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, tp, mDNSVal16(port));
14177             }
14178         mDNS_Unlock(m);
14179     }
14180 }
14181 
14182 mDNSexport void mDNSCoreReceiveRawPacket(mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
14183 {
14184     static const mDNSOpaque16 Ethertype_ARP  = { { 0x08, 0x06 } };  // Ethertype 0x0806 = ARP
14185     static const mDNSOpaque16 Ethertype_IPv4 = { { 0x08, 0x00 } };  // Ethertype 0x0800 = IPv4
14186     static const mDNSOpaque16 Ethertype_IPv6 = { { 0x86, 0xDD } };  // Ethertype 0x86DD = IPv6
14187     static const mDNSOpaque16 ARP_hrd_eth    = { { 0x00, 0x01 } };  // Hardware address space (Ethernet = 1)
14188     static const mDNSOpaque16 ARP_pro_ip     = { { 0x08, 0x00 } };  // Protocol address space (IP = 0x0800)
14189 
14190     // Note: BPF guarantees that the NETWORK LAYER header will be word aligned, not the link-layer header.
14191     // In other words, we can safely assume that pkt below (ARP, IPv4 or IPv6) is properly word aligned,
14192     // but if pkt is 4-byte aligned, that necessarily means that eth CANNOT also be 4-byte aligned
14193     // since it points to a an address 14 bytes before pkt.
14194     const EthernetHeader     *const eth = (const EthernetHeader *)p;
14195     const NetworkLayerPacket *const pkt = (const NetworkLayerPacket *)(eth+1);
14196     mDNSAddr src, dst;
14197     #define RequiredCapLen(P) ((P)==0x01 ? 4 : (P)==0x06 ? 20 : (P)==0x11 ? 8 : (P)==0x3A ? 24 : 0)
14198 
14199     // Is ARP? Length must be at least 14 + 28 = 42 bytes
14200     if (end >= p+42 && mDNSSameOpaque16(eth->ethertype, Ethertype_ARP) && mDNSSameOpaque16(pkt->arp.hrd, ARP_hrd_eth) && mDNSSameOpaque16(pkt->arp.pro, ARP_pro_ip))
14201         mDNSCoreReceiveRawARP(m, &pkt->arp, InterfaceID);
14202     // Is IPv4 with zero fragmentation offset? Length must be at least 14 + 20 = 34 bytes
14203     else if (end >= p+34 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv4) && (pkt->v4.flagsfrags.b[0] & 0x1F) == 0 && pkt->v4.flagsfrags.b[1] == 0)
14204     {
14205         const mDNSu8 *const trans = p + 14 + (pkt->v4.vlen & 0xF) * 4;
14206         const mDNSu8 * transEnd = p + 14 + mDNSVal16(pkt->v4.totlen);
14207         if (transEnd > end) transEnd = end;
14208         debugf("Got IPv4 %02X from %.4a to %.4a", pkt->v4.protocol, &pkt->v4.src, &pkt->v4.dst);
14209         src.type = mDNSAddrType_IPv4; src.ip.v4 = pkt->v4.src;
14210         dst.type = mDNSAddrType_IPv4; dst.ip.v4 = pkt->v4.dst;
14211         if (transEnd >= trans + RequiredCapLen(pkt->v4.protocol))
14212             mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v4.protocol, p, (TransportLayerPacket*)trans, transEnd, InterfaceID, 0);
14213     }
14214     // Is IPv6? Length must be at least 14 + 28 = 42 bytes
14215     else if (end >= p+54 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv6))
14216     {
14217         const mDNSu8 *const trans = p + 54;
14218         debugf("Got IPv6  %02X from %.16a to %.16a", pkt->v6.pro, &pkt->v6.src, &pkt->v6.dst);
14219         src.type = mDNSAddrType_IPv6; src.ip.v6 = pkt->v6.src;
14220         dst.type = mDNSAddrType_IPv6; dst.ip.v6 = pkt->v6.dst;
14221         if (end >= trans + RequiredCapLen(pkt->v6.pro))
14222             mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v6.pro, p, (TransportLayerPacket*)trans, end, InterfaceID,
14223                                               (mDNSu16)pkt->bytes[4] << 8 | pkt->bytes[5]);
14224     }
14225 }
14226 
14227 mDNSlocal void ConstructSleepProxyServerName(mDNS *const m, domainlabel *name)
14228 {
14229     name->c[0] = (mDNSu8)mDNS_snprintf((char*)name->c+1, 62, "%d-%d-%d-%d.%d %#s",
14230                                        m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags, &m->nicelabel);
14231 }
14232 
14233 #ifndef SPC_DISABLED
14234 mDNSlocal void SleepProxyServerCallback(mDNS *const m, ServiceRecordSet *const srs, mStatus result)
14235 {
14236     if (result == mStatus_NameConflict)
14237         mDNS_RenameAndReregisterService(m, srs, mDNSNULL);
14238     else if (result == mStatus_MemFree)
14239     {
14240         if (m->SleepState)
14241             m->SPSState = 3;
14242         else
14243         {
14244             m->SPSState = (mDNSu8)(m->SPSSocket != mDNSNULL);
14245             if (m->SPSState)
14246             {
14247                 domainlabel name;
14248                 ConstructSleepProxyServerName(m, &name);
14249                 mDNS_RegisterService(m, srs,
14250                                      &name, &SleepProxyServiceType, &localdomain,
14251                                      mDNSNULL, m->SPSSocket->port, // Host, port
14252                                      (mDNSu8 *)"", 1,           // TXT data, length
14253                                      mDNSNULL, 0,               // Subtypes (none)
14254                                      mDNSInterface_Any,         // Interface ID
14255                                      SleepProxyServerCallback, mDNSNULL, 0); // Callback, context, flags
14256             }
14257             LogSPS("Sleep Proxy Server %#s %s", srs->RR_SRV.resrec.name->c, m->SPSState ? "started" : "stopped");
14258         }
14259     }
14260 }
14261 #endif
14262 
14263 // Called with lock held
14264 mDNSexport void mDNSCoreBeSleepProxyServer_internal(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower, mDNSu8 features)
14265 {
14266     // This routine uses mDNS_DeregisterService and calls SleepProxyServerCallback, so we execute in user callback context
14267     mDNS_DropLockBeforeCallback();
14268 
14269     // If turning off SPS, close our socket
14270     // (Do this first, BEFORE calling mDNS_DeregisterService below)
14271     if (!sps && m->SPSSocket) { mDNSPlatformUDPClose(m->SPSSocket); m->SPSSocket = mDNSNULL; }
14272 
14273     // If turning off, or changing type, deregister old name
14274 #ifndef SPC_DISABLED
14275     if (m->SPSState == 1 && sps != m->SPSType)
14276     { m->SPSState = 2; mDNS_DeregisterService_drt(m, &m->SPSRecords, sps ? mDNS_Dereg_rapid : mDNS_Dereg_normal); }
14277 #endif // SPC_DISABLED
14278 
14279     // Record our new SPS parameters
14280     m->SPSType          = sps;
14281     m->SPSPortability   = port;
14282     m->SPSMarginalPower = marginalpower;
14283     m->SPSTotalPower    = totpower;
14284     m->SPSFeatureFlags  = features;
14285     // If turning on, open socket and advertise service
14286     if (sps)
14287     {
14288         if (!m->SPSSocket)
14289         {
14290             m->SPSSocket = mDNSPlatformUDPSocket(zeroIPPort);
14291             if (!m->SPSSocket) { LogMsg("mDNSCoreBeSleepProxyServer: Failed to allocate SPSSocket"); goto fail; }
14292         }
14293 #ifndef SPC_DISABLED
14294         if (m->SPSState == 0) SleepProxyServerCallback(m, &m->SPSRecords, mStatus_MemFree);
14295 #endif // SPC_DISABLED
14296     }
14297     else if (m->SPSState)
14298     {
14299         LogSPS("mDNSCoreBeSleepProxyServer turning off from state %d; will wake clients", m->SPSState);
14300         m->NextScheduledSPS = m->timenow;
14301     }
14302 fail:
14303     mDNS_ReclaimLockAfterCallback();
14304 }
14305 
14306 // ***************************************************************************
14307 #if COMPILER_LIKES_PRAGMA_MARK
14308 #pragma mark -
14309 #pragma mark - Startup and Shutdown
14310 #endif
14311 
14312 mDNSlocal void mDNS_GrowCache_internal(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14313 {
14314     if (storage && numrecords)
14315     {
14316         mDNSu32 i;
14317         debugf("Adding cache storage for %d more records (%d bytes)", numrecords, numrecords*sizeof(CacheEntity));
14318         for (i=0; i<numrecords; i++) storage[i].next = &storage[i+1];
14319         storage[numrecords-1].next = m->rrcache_free;
14320         m->rrcache_free = storage;
14321         m->rrcache_size += numrecords;
14322     }
14323 }
14324 
14325 mDNSexport void mDNS_GrowCache(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14326 {
14327     mDNS_Lock(m);
14328     mDNS_GrowCache_internal(m, storage, numrecords);
14329     mDNS_Unlock(m);
14330 }
14331 
14332 mDNSlocal mStatus mDNS_InitStorage(mDNS *const m, mDNS_PlatformSupport *const p,
14333                                    CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14334                                    mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14335 {
14336     mDNSu32 slot;
14337     mDNSs32 timenow;
14338     mStatus result;
14339 
14340     if (!rrcachestorage) rrcachesize = 0;
14341 
14342     m->p                             = p;
14343     m->NetworkChanged                = 0;
14344     m->CanReceiveUnicastOn5353       = mDNSfalse; // Assume we can't receive unicasts on 5353, unless platform layer tells us otherwise
14345     m->AdvertiseLocalAddresses       = AdvertiseLocalAddresses;
14346     m->DivertMulticastAdvertisements = mDNSfalse;
14347     m->mDNSPlatformStatus            = mStatus_Waiting;
14348     m->UnicastPort4                  = zeroIPPort;
14349     m->UnicastPort6                  = zeroIPPort;
14350     m->PrimaryMAC                    = zeroEthAddr;
14351     m->MainCallback                  = Callback;
14352     m->MainContext                   = Context;
14353     m->rec.r.resrec.RecordType       = 0;
14354     m->rec.r.resrec.AnonInfo         = mDNSNULL;
14355 
14356     // For debugging: To catch and report locking failures
14357     m->mDNS_busy               = 0;
14358     m->mDNS_reentrancy         = 0;
14359     m->ShutdownTime            = 0;
14360     m->lock_rrcache            = 0;
14361     m->lock_Questions          = 0;
14362     m->lock_Records            = 0;
14363 
14364     // Task Scheduling variables
14365     result = mDNSPlatformTimeInit();
14366     if (result != mStatus_NoError) return(result);
14367     m->timenow_adjust = (mDNSs32)mDNSRandom(0xFFFFFFFF);
14368     timenow = mDNS_TimeNow_NoLock(m);
14369 
14370     m->timenow                 = 0;     // MUST only be set within mDNS_Lock/mDNS_Unlock section
14371     m->timenow_last            = timenow;
14372     m->NextScheduledEvent      = timenow;
14373     m->SuppressSending         = timenow;
14374     m->NextCacheCheck          = timenow + FutureTime;
14375     m->NextScheduledQuery      = timenow + FutureTime;
14376     m->NextScheduledProbe      = timenow + FutureTime;
14377     m->NextScheduledResponse   = timenow + FutureTime;
14378     m->NextScheduledNATOp      = timenow + FutureTime;
14379     m->NextScheduledSPS        = timenow + FutureTime;
14380     m->NextScheduledKA         = timenow + FutureTime;
14381     m->NextScheduledStopTime   = timenow + FutureTime;
14382     m->NextBLEServiceTime      = 0;    // zero indicates inactive
14383 
14384 #if BONJOUR_ON_DEMAND
14385     m->NextBonjourDisableTime  = 0; // Timer active when non zero.
14386     m->BonjourEnabled          = 0; // Set when Bonjour on Demand is enabled and Bonjour is currently enabled.
14387 #endif // BONJOUR_ON_DEMAND
14388 
14389     m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
14390     m->RandomQueryDelay        = 0;
14391     m->RandomReconfirmDelay    = 0;
14392     m->PktNum                  = 0;
14393     m->MPktNum                 = 0;
14394     m->LocalRemoveEvents       = mDNSfalse;
14395     m->SleepState              = SleepState_Awake;
14396     m->SleepSeqNum             = 0;
14397     m->SystemWakeOnLANEnabled  = mDNSfalse;
14398     m->AnnounceOwner           = NonZeroTime(timenow + 60 * mDNSPlatformOneSecond);
14399     m->DelaySleep              = 0;
14400     m->SleepLimit              = 0;
14401 
14402 #if APPLE_OSX_mDNSResponder
14403     m->UnicastPacketsSent      = 0;
14404     m->MulticastPacketsSent    = 0;
14405     m->RemoteSubnet            = 0;
14406 #endif // APPLE_OSX_mDNSResponder
14407 
14408     // These fields only required for mDNS Searcher...
14409     m->Questions               = mDNSNULL;
14410     m->NewQuestions            = mDNSNULL;
14411     m->CurrentQuestion         = mDNSNULL;
14412     m->LocalOnlyQuestions      = mDNSNULL;
14413     m->NewLocalOnlyQuestions   = mDNSNULL;
14414     m->RestartQuestion         = mDNSNULL;
14415     m->ValidationQuestion      = mDNSNULL;
14416     m->rrcache_size            = 0;
14417     m->rrcache_totalused       = 0;
14418     m->rrcache_active          = 0;
14419     m->rrcache_report          = 10;
14420     m->rrcache_free            = mDNSNULL;
14421 
14422     for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
14423     {
14424         m->rrcache_hash[slot]      = mDNSNULL;
14425         m->rrcache_nextcheck[slot] = timenow + FutureTime;;
14426     }
14427 
14428     mDNS_GrowCache_internal(m, rrcachestorage, rrcachesize);
14429     m->rrauth.rrauth_free            = mDNSNULL;
14430 
14431     for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
14432         m->rrauth.rrauth_hash[slot] = mDNSNULL;
14433 
14434     // Fields below only required for mDNS Responder...
14435     m->hostlabel.c[0]          = 0;
14436     m->nicelabel.c[0]          = 0;
14437     m->MulticastHostname.c[0]  = 0;
14438     m->HIHardware.c[0]         = 0;
14439     m->HISoftware.c[0]         = 0;
14440     m->ResourceRecords         = mDNSNULL;
14441     m->DuplicateRecords        = mDNSNULL;
14442     m->NewLocalRecords         = mDNSNULL;
14443     m->NewLocalOnlyRecords     = mDNSfalse;
14444     m->CurrentRecord           = mDNSNULL;
14445     m->HostInterfaces          = mDNSNULL;
14446     m->ProbeFailTime           = 0;
14447     m->NumFailedProbes         = 0;
14448     m->SuppressProbes          = 0;
14449 
14450 #ifndef UNICAST_DISABLED
14451     m->NextuDNSEvent            = timenow + FutureTime;
14452     m->NextSRVUpdate            = timenow + FutureTime;
14453 
14454     m->DNSServers               = mDNSNULL;
14455 
14456     m->Router                   = zeroAddr;
14457     m->AdvertisedV4             = zeroAddr;
14458     m->AdvertisedV6             = zeroAddr;
14459 
14460     m->AuthInfoList             = mDNSNULL;
14461 
14462     m->ReverseMap.ThisQInterval = -1;
14463     m->StaticHostname.c[0]      = 0;
14464     m->FQDN.c[0]                = 0;
14465     m->Hostnames                = mDNSNULL;
14466     m->AutoTunnelNAT.clientContext = mDNSNULL;
14467 
14468     m->WABBrowseQueriesCount    = 0;
14469     m->WABLBrowseQueriesCount   = 0;
14470     m->WABRegQueriesCount       = 0;
14471     m->AutoTargetServices       = 1;
14472 
14473 #if BONJOUR_ON_DEMAND
14474     m->NumAllInterfaceRecords   = 0;
14475     m->NumAllInterfaceQuestions = 0;
14476 #endif
14477     // NAT traversal fields
14478     m->LLQNAT.clientCallback    = mDNSNULL;
14479     m->LLQNAT.clientContext     = mDNSNULL;
14480     m->NATTraversals            = mDNSNULL;
14481     m->CurrentNATTraversal      = mDNSNULL;
14482     m->retryIntervalGetAddr     = 0;    // delta between time sent and retry
14483     m->retryGetAddr             = timenow + FutureTime; // absolute time when we retry
14484     m->ExtAddress               = zerov4Addr;
14485     m->PCPNonce[0]              = mDNSRandom(-1);
14486     m->PCPNonce[1]              = mDNSRandom(-1);
14487     m->PCPNonce[2]              = mDNSRandom(-1);
14488 
14489     m->NATMcastRecvskt          = mDNSNULL;
14490     m->LastNATupseconds         = 0;
14491     m->LastNATReplyLocalTime    = timenow;
14492     m->LastNATMapResultCode     = NATErr_None;
14493 
14494     m->UPnPInterfaceID          = 0;
14495     m->SSDPSocket               = mDNSNULL;
14496     m->SSDPWANPPPConnection     = mDNSfalse;
14497     m->UPnPRouterPort           = zeroIPPort;
14498     m->UPnPSOAPPort             = zeroIPPort;
14499     m->UPnPRouterURL            = mDNSNULL;
14500     m->UPnPWANPPPConnection     = mDNSfalse;
14501     m->UPnPSOAPURL              = mDNSNULL;
14502     m->UPnPRouterAddressString  = mDNSNULL;
14503     m->UPnPSOAPAddressString    = mDNSNULL;
14504     m->SPSType                  = 0;
14505     m->SPSPortability           = 0;
14506     m->SPSMarginalPower         = 0;
14507     m->SPSTotalPower            = 0;
14508     m->SPSFeatureFlags          = 0;
14509     m->SPSState                 = 0;
14510     m->SPSProxyListChanged      = mDNSNULL;
14511     m->SPSSocket                = mDNSNULL;
14512     m->SPSBrowseCallback        = mDNSNULL;
14513     m->ProxyRecords             = 0;
14514 
14515     m->DNSPushServers           = mDNSNULL;
14516     m->DNSPushZones             = mDNSNULL;
14517 #endif
14518 
14519 #if APPLE_OSX_mDNSResponder
14520     m->TunnelClients            = mDNSNULL;
14521 
14522 #if !NO_WCF
14523     CHECK_WCF_FUNCTION(WCFConnectionNew)
14524     {
14525         m->WCF = WCFConnectionNew();
14526         if (!m->WCF) { LogMsg("WCFConnectionNew failed"); return -1; }
14527     }
14528 #endif
14529 
14530 #endif
14531 
14532     return(result);
14533 }
14534 
14535 mDNSexport mStatus mDNS_Init(mDNS *const m, mDNS_PlatformSupport *const p,
14536                              CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14537                              mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14538 {
14539     mStatus result = mDNS_InitStorage(m, p, rrcachestorage, rrcachesize, AdvertiseLocalAddresses, Callback, Context);
14540     if (result != mStatus_NoError)
14541         return(result);
14542 
14543     result = mDNSPlatformInit(m);
14544 
14545 #ifndef UNICAST_DISABLED
14546     // It's better to do this *after* the platform layer has set up the
14547     // interface list and security credentials
14548     uDNS_SetupDNSConfig(m);                     // Get initial DNS configuration
14549 #endif
14550 
14551     return(result);
14552 }
14553 
14554 mDNSexport void mDNS_ConfigChanged(mDNS *const m)
14555 {
14556     if (m->SPSState == 1)
14557     {
14558         domainlabel name, newname;
14559 #ifndef SPC_DISABLED
14560         domainname type, domain;
14561         DeconstructServiceName(m->SPSRecords.RR_SRV.resrec.name, &name, &type, &domain);
14562 #endif // SPC_DISABLED
14563         ConstructSleepProxyServerName(m, &newname);
14564         if (!SameDomainLabelCS(name.c, newname.c))
14565         {
14566             LogSPS("Renaming SPS from “%#s” to “%#s”", name.c, newname.c);
14567             // When SleepProxyServerCallback gets the mStatus_MemFree message,
14568             // it will reregister the service under the new name
14569             m->SPSState = 2;
14570 #ifndef SPC_DISABLED
14571             mDNS_DeregisterService_drt(m, &m->SPSRecords, mDNS_Dereg_rapid);
14572 #endif // SPC_DISABLED
14573         }
14574     }
14575 
14576     if (m->MainCallback)
14577         m->MainCallback(m, mStatus_ConfigChanged);
14578 }
14579 
14580 mDNSlocal void DynDNSHostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
14581 {
14582     (void)m;    // unused
14583     debugf("NameStatusCallback: result %d for registration of name %##s", result, rr->resrec.name->c);
14584     mDNSPlatformDynDNSHostNameStatusChanged(rr->resrec.name, result);
14585 }
14586 
14587 mDNSlocal void PurgeOrReconfirmCacheRecord(mDNS *const m, CacheRecord *cr, const DNSServer * const ptr, mDNSBool lameduck)
14588 {
14589     mDNSBool purge = cr->resrec.RecordType == kDNSRecordTypePacketNegative ||
14590                      cr->resrec.rrtype     == kDNSType_A ||
14591                      cr->resrec.rrtype     == kDNSType_AAAA ||
14592                      cr->resrec.rrtype     == kDNSType_SRV ||
14593                      cr->resrec.rrtype     == kDNSType_CNAME;
14594 
14595     (void) lameduck;
14596     (void) ptr;
14597     debugf("PurgeOrReconfirmCacheRecord: %s cache record due to %s server %p %#a:%d (%##s): %s",
14598            purge    ? "purging"   : "reconfirming",
14599            lameduck ? "lame duck" : "new",
14600            ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, CRDisplayString(m, cr));
14601 
14602     if (purge)
14603     {
14604         LogInfo("PurgeorReconfirmCacheRecord: Purging Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14605         mDNS_PurgeCacheResourceRecord(m, cr);
14606     }
14607     else
14608     {
14609         LogInfo("PurgeorReconfirmCacheRecord: Reconfirming Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14610         mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
14611     }
14612 }
14613 
14614 mDNSlocal void mDNS_PurgeForQuestion(mDNS *const m, DNSQuestion *q)
14615 {
14616     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14617     CacheRecord *rp;
14618     mDNSu8 validatingResponse = 0;
14619 
14620     // For DNSSEC questions, purge the corresponding RRSIGs also.
14621     if (DNSSECQuestion(q))
14622     {
14623         validatingResponse = q->ValidatingResponse;
14624         q->ValidatingResponse = mDNStrue;
14625     }
14626     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14627     {
14628         if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14629         {
14630             LogInfo("mDNS_PurgeForQuestion: Flushing %s", CRDisplayString(m, rp));
14631             mDNS_PurgeCacheResourceRecord(m, rp);
14632         }
14633     }
14634     if (DNSSECQuestion(q))
14635     {
14636         q->ValidatingResponse = validatingResponse;
14637     }
14638 }
14639 
14640 // For DNSSEC question, we need the DNSSEC records also. If the cache does not
14641 // have the DNSSEC records, we need to re-issue the question with EDNS0/DO bit set.
14642 // Just re-issuing the question for RRSIGs does not work in practice as the response
14643 // may not contain the RRSIGs whose typeCovered field matches the question's qtype.
14644 //
14645 // For negative responses, we need the NSECs to prove the non-existence. If we don't
14646 // have the cached NSECs, purge them. For positive responses, if we don't have the
14647 // RRSIGs and if we have not already issued the question with EDNS0/DO bit set, purge
14648 // them.
14649 mDNSlocal void CheckForDNSSECRecords(mDNS *const m, DNSQuestion *q)
14650 {
14651     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14652     CacheRecord *rp;
14653 
14654     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14655     {
14656         if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14657         {
14658             if (rp->resrec.RecordType != kDNSRecordTypePacketNegative || !rp->nsec)
14659             {
14660                 if (!rp->CRDNSSECQuestion)
14661                 {
14662                     LogInfo("CheckForDNSSECRecords: Flushing %s", CRDisplayString(m, rp));
14663                     mDNS_PurgeCacheResourceRecord(m, rp);
14664                 }
14665             }
14666         }
14667     }
14668 }
14669 
14670 // Check for a positive unicast response to the question but with qtype
14671 mDNSexport mDNSBool mDNS_CheckForCacheRecord(mDNS *const m, DNSQuestion *q, mDNSu16 qtype)
14672 {
14673     DNSQuestion question;
14674     CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14675     CacheRecord *rp;
14676 
14677     // Create an identical question but with qtype
14678     mDNS_SetupQuestion(&question, q->InterfaceID, &q->qname, qtype, mDNSNULL, mDNSNULL);
14679     question.qDNSServer = q->qDNSServer;
14680 
14681     for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14682     {
14683         if (!rp->resrec.InterfaceID && rp->resrec.RecordType != kDNSRecordTypePacketNegative &&
14684             SameNameRecordAnswersQuestion(&rp->resrec, &question))
14685         {
14686             LogInfo("mDNS_CheckForCacheRecord: Found %s", CRDisplayString(m, rp));
14687             return mDNStrue;
14688         }
14689     }
14690     return mDNSfalse;
14691 }
14692 
14693 mDNSexport void DNSServerChangeForQuestion(mDNS *const m, DNSQuestion *q, DNSServer *new)
14694 {
14695     DNSQuestion *qptr;
14696 
14697     (void) m;
14698 
14699     if (q->DuplicateOf)
14700         LogMsg("DNSServerChangeForQuestion: ERROR: Called for duplicate question %##s", q->qname.c);
14701 
14702     // Make sure all the duplicate questions point to the same DNSServer so that delivery
14703     // of events for all of them are consistent. Duplicates for a question are always inserted
14704     // after in the list.
14705     q->qDNSServer = new;
14706     for (qptr = q->next ; qptr; qptr = qptr->next)
14707     {
14708         if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = new; }
14709     }
14710 }
14711 
14712 mDNSlocal void SetConfigState(mDNS *const m, mDNSBool delete)
14713 {
14714     McastResolver *mr;
14715     DNSServer *ptr;
14716 
14717     if (delete)
14718     {
14719         for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14720         {
14721             ptr->penaltyTime = 0;
14722             NumUnicastDNSServers--;
14723             ptr->flags |= DNSServer_FlagDelete;
14724 #if APPLE_OSX_mDNSResponder
14725             if (ptr->flags & DNSServer_FlagUnreachable)
14726                 NumUnreachableDNSServers--;
14727 #endif
14728         }
14729         // We handle the mcast resolvers here itself as mDNSPlatformSetDNSConfig looks at
14730         // mcast resolvers. Today we get both mcast and ucast configuration using the same
14731         // API
14732         for (mr = m->McastResolvers; mr; mr = mr->next)
14733             mr->flags |= McastResolver_FlagDelete;
14734     }
14735     else
14736     {
14737         for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14738         {
14739             ptr->penaltyTime = 0;
14740             NumUnicastDNSServers++;
14741             ptr->flags &= ~DNSServer_FlagDelete;
14742 #if APPLE_OSX_mDNSResponder
14743             if (ptr->flags & DNSServer_FlagUnreachable)
14744                 NumUnreachableDNSServers++;
14745 #endif
14746         }
14747         for (mr = m->McastResolvers; mr; mr = mr->next)
14748             mr->flags &= ~McastResolver_FlagDelete;
14749     }
14750 }
14751 
14752 mDNSlocal void SetDynDNSHostNameIfChanged(mDNS *const m, domainname *const fqdn)
14753 {
14754     // Did our FQDN change?
14755     if (!SameDomainName(fqdn, &m->FQDN))
14756     {
14757         if (m->FQDN.c[0]) mDNS_RemoveDynDNSHostName(m, &m->FQDN);
14758 
14759         AssignDomainName(&m->FQDN, fqdn);
14760 
14761         if (m->FQDN.c[0])
14762         {
14763             mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1);
14764             mDNS_AddDynDNSHostName(m, &m->FQDN, DynDNSHostNameCallback, mDNSNULL);
14765         }
14766     }
14767 }
14768 
14769 mDNSexport mStatus uDNS_SetupDNSConfig(mDNS *const m)
14770 {
14771     mDNSu32 slot;
14772     CacheGroup *cg;
14773     CacheRecord *cr;
14774     mDNSBool Restart = mDNSfalse;
14775     mDNSAddr v4, v6, r;
14776     domainname fqdn;
14777     DNSServer   *ptr, **p = &m->DNSServers;
14778     const DNSServer *oldServers = m->DNSServers;
14779     DNSQuestion *q;
14780     McastResolver *mr, **mres = &m->McastResolvers;
14781 
14782     debugf("uDNS_SetupDNSConfig: entry");
14783 
14784     // Let the platform layer get the current DNS information and setup the WAB queries if needed.
14785     uDNS_SetupWABQueries(m);
14786 
14787     mDNS_Lock(m);
14788 
14789     // We need to first mark all the entries to be deleted. If the configuration changed, then
14790     // the entries would be undeleted appropriately. Otherwise, we need to clear them.
14791     //
14792     // Note: The last argument to mDNSPlatformSetDNSConfig is "mDNStrue" which means ack the
14793     // configuration. We already processed search domains in uDNS_SetupWABQueries above and
14794     // hence we are ready to ack the configuration as this is the last call to mDNSPlatformSetConfig
14795     // for the dns configuration change notification.
14796     SetConfigState(m, mDNStrue);
14797     if (!mDNSPlatformSetDNSConfig(mDNStrue, mDNSfalse, &fqdn, mDNSNULL, mDNSNULL, mDNStrue))
14798     {
14799         SetDynDNSHostNameIfChanged(m, &fqdn);
14800         SetConfigState(m, mDNSfalse);
14801         mDNS_Unlock(m);
14802         LogInfo("uDNS_SetupDNSConfig: No configuration change");
14803         return mStatus_NoError;
14804     }
14805 
14806     // For now, we just delete the mcast resolvers. We don't deal with cache or
14807     // questions here. Neither question nor cache point to mcast resolvers. Questions
14808     // do inherit the timeout values from mcast resolvers. But we don't bother
14809     // affecting them as they never change.
14810     while (*mres)
14811     {
14812         if (((*mres)->flags & McastResolver_FlagDelete) != 0)
14813         {
14814             mr = *mres;
14815             *mres = (*mres)->next;
14816             debugf("uDNS_SetupDNSConfig: Deleting mcast resolver %##s", mr, mr->domain.c);
14817             mDNSPlatformMemFree(mr);
14818         }
14819         else
14820         {
14821             (*mres)->flags &= ~McastResolver_FlagNew;
14822             mres = &(*mres)->next;
14823         }
14824     }
14825 
14826     // Update our qDNSServer pointers before we go and free the DNSServer object memory
14827     //
14828     // All non-scoped resolvers share the same resGroupID. At no point in time a cache entry using DNSServer
14829     // from scoped resolver will be used to answer non-scoped questions and vice versa, as scoped and non-scoped
14830     // resolvers don't share the same resGroupID. A few examples to describe the interaction with how we pick
14831     // DNSServers and flush the cache.
14832     //
14833     // - A non-scoped question picks DNSServer X, creates a cache entry with X. If a new resolver gets added later that
14834     //   is a better match, we pick the new DNSServer for the question and activate the unicast query. We may or may not
14835     //   flush the cache (See PurgeOrReconfirmCacheRecord). In either case, we don't change the cache record's DNSServer
14836     //   pointer immediately (qDNSServer and rDNSServer may be different but still share the same resGroupID). If we don't
14837     //   flush the cache immediately, the record's rDNSServer pointer will be updated (in mDNSCoreReceiveResponse)
14838     //   later when we get the response. If we purge the cache, we still deliver a RMV when it is purged even though
14839     //   we don't update the cache record's DNSServer pointer to match the question's DNSSever, as they both point to
14840     //   the same resGroupID.
14841     //
14842     //   Note: If the new DNSServer comes back with a different response than what we have in the cache, we will deliver a RMV
14843     //   of the old followed by ADD of the new records.
14844     //
14845     // - A non-scoped question picks DNSServer X,  creates a cache entry with X. If the resolver gets removed later, we will
14846     //   pick a new DNSServer for the question which may or may not be NULL and set the cache record's pointer to the same
14847     //   as in question's qDNSServer if the cache record is not flushed. If there is no active question, it will be set to NULL.
14848     //
14849     // - Two questions scoped and non-scoped for the same name will pick two different DNSServer and will end up creating separate
14850     //   cache records and as the resGroupID is different, you can't use the cache record from the scoped DNSServer to answer the
14851     //   non-scoped question and vice versa.
14852     //
14853 #if USE_DNS64
14854     DNS64RestartQuestions(m);
14855 #endif
14856     for (q = m->Questions; q; q=q->next)
14857     {
14858         if (!mDNSOpaque16IsZero(q->TargetQID))
14859         {
14860             DNSServer *s, *t;
14861             DNSQuestion *qptr;
14862             if (q->DuplicateOf) continue;
14863             SetValidDNSServers(m, q);
14864             q->triedAllServersOnce = 0;
14865             s = GetServerForQuestion(m, q);
14866             t = q->qDNSServer;
14867             if (t != s)
14868             {
14869                 mDNSBool old, new;
14870                 // If DNS Server for this question has changed, reactivate it
14871                 LogInfo("uDNS_SetupDNSConfig: Updating DNS Server from %#a:%d (%##s) to %#a:%d (%##s) for question %##s (%s) (scope:%p)",
14872                         t ? &t->addr : mDNSNULL, mDNSVal16(t ? t->port : zeroIPPort), t ? t->domain.c : (mDNSu8*)"",
14873                         s ? &s->addr : mDNSNULL, mDNSVal16(s ? s->port : zeroIPPort), s ? s->domain.c : (mDNSu8*)"",
14874                         q->qname.c, DNSTypeName(q->qtype), q->InterfaceID);
14875 
14876                 old = q->SuppressQuery;
14877                 new = ShouldSuppressUnicastQuery(m, q, s);
14878                 if (old != new)
14879                 {
14880                     // Changing the DNS server affected the SuppressQuery status. We need to
14881                     // deliver RMVs for the previous ADDs (if any) before switching to the new
14882                     // DNSServer.  To keep it simple, we walk all the questions and mark them
14883                     // to be restarted and then handle all of them at once.
14884                     q->Restart = 1;
14885                     q->SuppressQuery = new;
14886                     for (qptr = q->next ; qptr; qptr = qptr->next)
14887                     {
14888                         if (qptr->DuplicateOf == q)
14889                             qptr->Restart = 1;
14890                     }
14891                     Restart = mDNStrue;
14892                 }
14893                 else
14894                 {
14895                     DNSServerChangeForQuestion(m, q, s);
14896                     q->unansweredQueries = 0;
14897 
14898                     // If we had sent a query out to DNSServer "t" and we are changing to "s", we
14899                     // need to ignore the responses coming back from "t" as the DNS configuration
14900                     // has changed e.g., when a new interface is coming up and that becomes the primary
14901                     // interface, we switch to the DNS servers configured for the primary interface. In
14902                     // this case, we should not accept responses associated with the previous interface as
14903                     // the "name" could resolve differently on this new primary interface. Hence, discard
14904                     // in-flight responses.
14905                     q->TargetQID = mDNS_NewMessageID(m);
14906 
14907                     if (!QuerySuppressed(q))
14908                     {
14909                         debugf("uDNS_SetupDNSConfig: Activating query %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
14910                         ActivateUnicastQuery(m, q, mDNStrue);
14911                         // ActivateUnicastQuery is called for duplicate questions also as it does something
14912                         // special for AutoTunnel questions
14913                         for (qptr = q->next ; qptr; qptr = qptr->next)
14914                         {
14915                             if (qptr->DuplicateOf == q) ActivateUnicastQuery(m, qptr, mDNStrue);
14916                         }
14917                     }
14918                 }
14919             }
14920             else
14921             {
14922                 debugf("uDNS_SetupDNSConfig: Not Updating DNS server question %p %##s (%s) DNS server %#a:%d %p %d",
14923                        q, q->qname.c, DNSTypeName(q->qtype), t ? &t->addr : mDNSNULL, mDNSVal16(t ? t->port : zeroIPPort), q->DuplicateOf, q->SuppressUnusable);
14924                 for (qptr = q->next ; qptr; qptr = qptr->next)
14925                     if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = q->qDNSServer; }
14926             }
14927         }
14928     }
14929     if (Restart)
14930         RestartUnicastQuestions(m);
14931 
14932     FORALL_CACHERECORDS(slot, cg, cr)
14933     {
14934         if (cr->resrec.InterfaceID)
14935             continue;
14936 
14937         // We already walked the questions and restarted/reactivated them if the dns server
14938         // change affected the question. That should take care of updating the cache. But
14939         // what if there is no active question at this point when the DNS server change
14940         // happened ? There could be old cache entries lying around and if we don't flush
14941         // them, a new question after the DNS server change could pick up these stale
14942         // entries and get a wrong answer.
14943         //
14944         // For cache entries that have active questions we might have skipped rescheduling
14945         // the questions if they were suppressed (see above). To keep it simple, we walk
14946         // all the cache entries to make sure that there are no stale entries. We use the
14947         // active question's InterfaceID/ServiceID for looking up the right DNS server.
14948         // Note that the unscoped value for ServiceID is -1.
14949         //
14950         // Note: If GetServerForName returns NULL, it could either mean that there are no
14951         // DNS servers or no matching DNS servers for this question. In either case,
14952         // the cache should get purged below when we process deleted DNS servers.
14953 
14954         ptr = GetServerForName(m, cr->resrec.name,
14955                                (cr->CRActiveQuestion ? cr->CRActiveQuestion->InterfaceID : mDNSNULL),
14956                                (cr->CRActiveQuestion ? cr->CRActiveQuestion->ServiceID   : -1));
14957 
14958         // Purge or Reconfirm if this cache entry would use the new DNS server
14959         if (ptr && (ptr != cr->resrec.rDNSServer))
14960         {
14961             // As the DNSServers for this cache record is not the same anymore, we don't
14962             // want any new questions to pick this old value. If there is no active question,
14963             // we can't possibly re-confirm, so purge in that case. If it is a DNSSEC question,
14964             // purge the cache as the DNSSEC capabilities of the DNS server may have changed.
14965 
14966             if (cr->CRActiveQuestion == mDNSNULL || DNSSECQuestion(cr->CRActiveQuestion))
14967             {
14968                 LogInfo("uDNS_SetupDNSConfig: Purging Resourcerecord %s, New DNS server %#a , Old DNS server %#a", CRDisplayString(m, cr),
14969                         &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ?  &cr->resrec.rDNSServer->addr : mDNSNULL));
14970                 mDNS_PurgeCacheResourceRecord(m, cr);
14971             }
14972             else
14973             {
14974                 LogInfo("uDNS_SetupDNSConfig: Purging/Reconfirming Resourcerecord %s, New DNS server %#a, Old DNS server %#a", CRDisplayString(m, cr),
14975                         &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ?  &cr->resrec.rDNSServer->addr : mDNSNULL));
14976                 PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNSfalse);
14977             }
14978         }
14979 
14980         // If a cache record's DNSServer pointer is NULL, but its active question got a DNSServer in this DNS configuration
14981         // update, then use its DNSServer. This way, the active question and its duplicates don't miss out on RMV events.
14982         if (!cr->resrec.rDNSServer && cr->CRActiveQuestion && cr->CRActiveQuestion->qDNSServer)
14983         {
14984             cr->resrec.rDNSServer = cr->CRActiveQuestion->qDNSServer;
14985             LogInfo("uDNS_SetupDNSConfig: Using active question's DNS server %#a for cache record %s", &cr->resrec.rDNSServer->addr, CRDisplayString(m, cr));
14986         }
14987     }
14988 
14989     while (*p)
14990     {
14991         if (((*p)->flags & DNSServer_FlagDelete) != 0)
14992         {
14993             // Scan our cache, looking for uDNS records that we would have queried this server for.
14994             // We reconfirm any records that match, because in this world of split DNS, firewalls, etc.
14995             // different DNS servers can give different answers to the same question.
14996             ptr = *p;
14997             FORALL_CACHERECORDS(slot, cg, cr)
14998             {
14999                 if (cr->resrec.InterfaceID) continue;
15000                 if (cr->resrec.rDNSServer == ptr)
15001                 {
15002                     // If we don't have an active question for this cache record, neither Purge can
15003                     // generate RMV events nor Reconfirm can send queries out. Just set the DNSServer
15004                     // pointer on the record NULL so that we don't point to freed memory (We might dereference
15005                     // DNSServer pointers from resource record for logging purposes).
15006                     //
15007                     // If there is an active question, point to its DNSServer as long as it does not point to the
15008                     // freed one. We already went through the questions above and made them point at either the
15009                     // new server or NULL if there is no server.
15010 
15011                     if (cr->CRActiveQuestion)
15012                     {
15013                         DNSQuestion *qptr = cr->CRActiveQuestion;
15014 
15015                         if (qptr->qDNSServer == ptr)
15016                         {
15017                             LogMsg("uDNS_SetupDNSConfig: ERROR!! Cache Record %s  Active question %##s (%s) (scope:%p) pointing to DNSServer Address %#a"
15018                                    " to be freed", CRDisplayString(m, cr),  qptr->qname.c, DNSTypeName(qptr->qtype), qptr->InterfaceID, &ptr->addr);
15019                             qptr->validDNSServers = zeroOpaque128;
15020                             qptr->qDNSServer = mDNSNULL;
15021                             cr->resrec.rDNSServer = mDNSNULL;
15022                         }
15023                         else
15024                         {
15025                             LogInfo("uDNS_SetupDNSConfig: Cache Record %s,  Active question %##s (%s) (scope:%p), pointing to DNSServer %#a (to be deleted),"
15026                                     " resetting to  question's DNSServer Address %#a", CRDisplayString(m, cr),  qptr->qname.c, DNSTypeName(qptr->qtype),
15027                                     qptr->InterfaceID, &ptr->addr, (qptr->qDNSServer) ? &qptr->qDNSServer->addr : mDNSNULL);
15028                             cr->resrec.rDNSServer = qptr->qDNSServer;
15029                         }
15030                     }
15031                     else
15032                     {
15033                         LogInfo("uDNS_SetupDNSConfig: Cache Record %##s has no Active question, Record's DNSServer Address %#a, Server to be deleted %#a",
15034                                 cr->resrec.name, &cr->resrec.rDNSServer->addr, &ptr->addr);
15035                         cr->resrec.rDNSServer = mDNSNULL;
15036                     }
15037 
15038                     PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNStrue);
15039                 }
15040             }
15041             *p = (*p)->next;
15042             LogInfo("uDNS_SetupDNSConfig: Deleting server %p %#a:%d (%##s) %d", ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, NumUnicastDNSServers);
15043             mDNSPlatformMemFree(ptr);
15044         }
15045         else
15046         {
15047             (*p)->flags &= ~DNSServer_FlagNew;
15048             p = &(*p)->next;
15049         }
15050     }
15051 
15052     // 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).
15053     // This is important for giving prompt remove events when the user disconnects the Ethernet cable or turns off wireless.
15054     // Otherwise, stale data lingers for 5-10 seconds, which is not the user-experience people expect from Bonjour.
15055     // 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.
15056     if ((m->DNSServers != mDNSNULL) != (oldServers != mDNSNULL))
15057     {
15058         int count = 0;
15059         FORALL_CACHERECORDS(slot, cg, cr)
15060         {
15061             if (!cr->resrec.InterfaceID)
15062             {
15063                 mDNS_PurgeCacheResourceRecord(m, cr);
15064                 count++;
15065             }
15066         }
15067         LogInfo("uDNS_SetupDNSConfig: %s available; purged %d unicast DNS records from cache",
15068                 m->DNSServers ? "DNS server became" : "No DNS servers", count);
15069 
15070         // Force anything that needs to get zone data to get that information again
15071         RestartRecordGetZoneData(m);
15072     }
15073 
15074     SetDynDNSHostNameIfChanged(m, &fqdn);
15075 
15076     mDNS_Unlock(m);
15077 
15078     // handle router and primary interface changes
15079     v4 = v6 = r = zeroAddr;
15080     v4.type = r.type = mDNSAddrType_IPv4;
15081 
15082     if (mDNSPlatformGetPrimaryInterface(&v4, &v6, &r) == mStatus_NoError && !mDNSv4AddressIsLinkLocal(&v4.ip.v4))
15083     {
15084         mDNS_SetPrimaryInterfaceInfo(m,
15085                                      !mDNSIPv4AddressIsZero(v4.ip.v4) ? &v4 : mDNSNULL,
15086                                      !mDNSIPv6AddressIsZero(v6.ip.v6) ? &v6 : mDNSNULL,
15087                                      !mDNSIPv4AddressIsZero(r.ip.v4) ? &r  : mDNSNULL);
15088     }
15089     else
15090     {
15091         mDNS_SetPrimaryInterfaceInfo(m, mDNSNULL, mDNSNULL, mDNSNULL);
15092         if (m->FQDN.c[0]) mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1); // Set status to 1 to indicate temporary failure
15093     }
15094 
15095     debugf("uDNS_SetupDNSConfig: number of unicast DNS servers %d", NumUnicastDNSServers);
15096     return mStatus_NoError;
15097 }
15098 
15099 mDNSexport void mDNSCoreInitComplete(mDNS *const m, mStatus result)
15100 {
15101     m->mDNSPlatformStatus = result;
15102     if (m->MainCallback)
15103     {
15104         mDNS_Lock(m);
15105         mDNS_DropLockBeforeCallback();      // Allow client to legally make mDNS API calls from the callback
15106         m->MainCallback(m, mStatus_NoError);
15107         mDNS_ReclaimLockAfterCallback();    // Decrement mDNS_reentrancy to block mDNS API calls again
15108         mDNS_Unlock(m);
15109     }
15110 }
15111 
15112 mDNSlocal void DeregLoop(mDNS *const m, AuthRecord *const start)
15113 {
15114     m->CurrentRecord = start;
15115     while (m->CurrentRecord)
15116     {
15117         AuthRecord *rr = m->CurrentRecord;
15118         LogInfo("DeregLoop: %s deregistration for %p %02X %s",
15119                 (rr->resrec.RecordType != kDNSRecordTypeDeregistering) ? "Initiating  " : "Accelerating",
15120                 rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15121         if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
15122             mDNS_Deregister_internal(m, rr, mDNS_Dereg_rapid);
15123         else if (rr->AnnounceCount > 1)
15124         {
15125             rr->AnnounceCount = 1;
15126             rr->LastAPTime = m->timenow - rr->ThisAPInterval;
15127         }
15128         // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
15129         // new records could have been added to the end of the list as a result of that call.
15130         if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
15131             m->CurrentRecord = rr->next;
15132     }
15133 }
15134 
15135 mDNSexport void mDNS_StartExit(mDNS *const m)
15136 {
15137     AuthRecord *rr;
15138 
15139     mDNS_Lock(m);
15140 
15141     LogInfo("mDNS_StartExit");
15142     m->ShutdownTime = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
15143 
15144     mDNSCoreBeSleepProxyServer_internal(m, 0, 0, 0, 0, 0);
15145 
15146 #if APPLE_OSX_mDNSResponder
15147 #if !NO_WCF
15148     CHECK_WCF_FUNCTION(WCFConnectionDealloc)
15149     {
15150         if (m->WCF) WCFConnectionDealloc((WCFConnection *)m->WCF);
15151     }
15152 #endif
15153 #endif
15154 
15155 #ifndef UNICAST_DISABLED
15156     {
15157         SearchListElem *s;
15158         SuspendLLQs(m);
15159         // Don't need to do SleepRecordRegistrations() here
15160         // because we deregister all records and services later in this routine
15161         while (m->Hostnames) mDNS_RemoveDynDNSHostName(m, &m->Hostnames->fqdn);
15162 
15163         // For each member of our SearchList, deregister any records it may have created, and cut them from the list.
15164         // Otherwise they'll be forcibly deregistered for us (without being cut them from the appropriate list)
15165         // and we may crash because the list still contains dangling pointers.
15166         for (s = SearchList; s; s = s->next)
15167             while (s->AuthRecs)
15168             {
15169                 ARListElem *dereg = s->AuthRecs;
15170                 s->AuthRecs = s->AuthRecs->next;
15171                 mDNS_Deregister_internal(m, &dereg->ar, mDNS_Dereg_normal); // Memory will be freed in the FreeARElemCallback
15172             }
15173     }
15174 #endif
15175 
15176     DeadvertiseAllInterfaceRecords(m);
15177 
15178     // Shut down all our active NAT Traversals
15179     while (m->NATTraversals)
15180     {
15181         NATTraversalInfo *t = m->NATTraversals;
15182         mDNS_StopNATOperation_internal(m, t);       // This will cut 't' from the list, thereby advancing m->NATTraversals in the process
15183 
15184         // After stopping the NAT Traversal, we zero out the fields.
15185         // This has particularly important implications for our AutoTunnel records --
15186         // when we deregister our AutoTunnel records below, we don't want their mStatus_MemFree
15187         // handlers to just turn around and attempt to re-register those same records.
15188         // Clearing t->ExternalPort/t->RequestedPort will cause the mStatus_MemFree callback handlers
15189         // to not do this.
15190         t->ExternalAddress = zerov4Addr;
15191         t->NewAddress      = zerov4Addr;
15192         t->ExternalPort    = zeroIPPort;
15193         t->RequestedPort   = zeroIPPort;
15194         t->Lifetime        = 0;
15195         t->Result          = mStatus_NoError;
15196     }
15197 
15198     // Make sure there are nothing but deregistering records remaining in the list
15199     if (m->CurrentRecord)
15200         LogMsg("mDNS_StartExit: ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
15201 
15202     // We're in the process of shutting down, so queries, etc. are no longer available.
15203     // Consequently, determining certain information, e.g. the uDNS update server's IP
15204     // address, will not be possible.  The records on the main list are more likely to
15205     // already contain such information, so we deregister the duplicate records first.
15206     LogInfo("mDNS_StartExit: Deregistering duplicate resource records");
15207     DeregLoop(m, m->DuplicateRecords);
15208     LogInfo("mDNS_StartExit: Deregistering resource records");
15209     DeregLoop(m, m->ResourceRecords);
15210 
15211     // If we scheduled a response to send goodbye packets, we set NextScheduledResponse to now. Normally when deregistering records,
15212     // we allow up to 100ms delay (to help improve record grouping) but when shutting down we don't want any such delay.
15213     if (m->NextScheduledResponse - m->timenow < mDNSPlatformOneSecond)
15214     {
15215         m->NextScheduledResponse = m->timenow;
15216         m->SuppressSending = 0;
15217     }
15218 
15219     if (m->ResourceRecords) LogInfo("mDNS_StartExit: Sending final record deregistrations");
15220     else LogInfo("mDNS_StartExit: No deregistering records remain");
15221 
15222     for (rr = m->DuplicateRecords; rr; rr = rr->next)
15223         LogMsg("mDNS_StartExit: Should not still have Duplicate Records remaining: %02X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
15224 
15225     // If any deregistering records remain, send their deregistration announcements before we exit
15226     if (m->mDNSPlatformStatus != mStatus_NoError) DiscardDeregistrations(m);
15227 
15228     mDNS_Unlock(m);
15229 
15230     LogInfo("mDNS_StartExit: done");
15231 }
15232 
15233 mDNSexport void mDNS_FinalExit(mDNS *const m)
15234 {
15235     mDNSu32 rrcache_active = 0;
15236     mDNSu32 rrcache_totalused = m->rrcache_totalused;
15237     mDNSu32 slot;
15238     AuthRecord *rr;
15239 
15240     LogInfo("mDNS_FinalExit: mDNSPlatformClose");
15241     mDNSPlatformClose(m);
15242 
15243     for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
15244     {
15245         while (m->rrcache_hash[slot])
15246         {
15247             CacheGroup *cg = m->rrcache_hash[slot];
15248             while (cg->members)
15249             {
15250                 CacheRecord *cr = cg->members;
15251                 cg->members = cg->members->next;
15252                 if (cr->CRActiveQuestion) rrcache_active++;
15253                 ReleaseCacheRecord(m, cr);
15254             }
15255             cg->rrcache_tail = &cg->members;
15256             ReleaseCacheGroup(m, &m->rrcache_hash[slot]);
15257         }
15258     }
15259     debugf("mDNS_FinalExit: RR Cache was using %ld records, %lu active", rrcache_totalused, rrcache_active);
15260     if (rrcache_active != m->rrcache_active)
15261         LogMsg("*** ERROR *** rrcache_totalused %lu; rrcache_active %lu != m->rrcache_active %lu", rrcache_totalused, rrcache_active, m->rrcache_active);
15262 
15263     for (rr = m->ResourceRecords; rr; rr = rr->next)
15264         LogMsg("mDNS_FinalExit failed to send goodbye for: %p %02X %s", rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15265 
15266     LogInfo("mDNS_FinalExit: done");
15267 }
15268 
15269 #ifdef UNIT_TEST
15270 #include "../unittests/mdns_ut.c"
15271 #endif
15272