<rdar://problem/7252523> The solution to the problem consists of many parts.
[people/sha0/mDNSResponder.git] / mDNSCore / mDNSEmbeddedAPI.h
1 /* -*- Mode: C; tab-width: 4 -*-
2  *
3  * Copyright (c) 2002-2003 Apple Computer, 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    NOTE:
18    If you're building an application that uses DNS Service Discovery
19    this is probably NOT the header file you're looking for.
20    In most cases you will want to use /usr/include/dns_sd.h instead.
21
22    This header file defines the lowest level raw interface to mDNSCore,
23    which is appropriate *only* on tiny embedded systems where everything
24    runs in a single address space and memory is extremely constrained.
25    All the APIs here are malloc-free, which means that the caller is
26    responsible for passing in a pointer to the relevant storage that
27    will be used in the execution of that call, and (when called with
28    correct parameters) all the calls are guaranteed to succeed. There
29    is never a case where a call can suffer intermittent failures because
30    the implementation calls malloc() and sometimes malloc() returns NULL
31    because memory is so limited that no more is available.
32    This is primarily for devices that need to have precisely known fixed
33    memory requirements, with absolutely no uncertainty or run-time variation,
34    but that certainty comes at a cost of more difficult programming.
35    
36    For applications running on general-purpose desktop operating systems
37    (Mac OS, Linux, Solaris, Windows, etc.) the API you should use is
38    /usr/include/dns_sd.h, which defines the API by which multiple
39    independent client processes communicate their DNS Service Discovery
40    requests to a single "mdnsd" daemon running in the background.
41    
42    Even on platforms that don't run multiple independent processes in
43    multiple independent address spaces, you can still use the preferred
44    dns_sd.h APIs by linking in "dnssd_clientshim.c", which implements
45    the standard "dns_sd.h" API calls, allocates any required storage
46    using malloc(), and then calls through to the low-level malloc-free
47    mDNSCore routines defined here. This has the benefit that even though
48    you're running on a small embedded system with a single address space,
49    you can still use the exact same client C code as you'd use on a
50    general-purpose desktop system.
51
52  */
53
54 #ifndef __mDNSClientAPI_h
55 #define __mDNSClientAPI_h
56
57 #if defined(EFI32) || defined(EFI64) || defined(EFIX64)
58 // EFI doesn't have stdarg.h unless it's building with GCC.
59 #include "Tiano.h"
60 #if !defined(__GNUC__)
61 #define va_list         VA_LIST
62 #define va_start(a, b)  VA_START(a, b)
63 #define va_end(a)       VA_END(a)
64 #define va_arg(a, b)    VA_ARG(a, b)
65 #endif
66 #else
67 #include <stdarg.h>             // stdarg.h is required for for va_list support for the mDNS_vsnprintf declaration
68 #endif
69
70 #include "mDNSDebug.h"
71 #if APPLE_OSX_mDNSResponder
72 #include <uuid/uuid.h>
73 #endif
74
75 #ifdef __cplusplus
76         extern "C" {
77 #endif
78
79 // ***************************************************************************
80 // Function scope indicators
81
82 // If you see "mDNSlocal" before a function name in a C file, it means the function is not callable outside this file
83 #ifndef mDNSlocal
84 #define mDNSlocal static
85 #endif
86 // If you see "mDNSexport" before a symbol in a C file, it means the symbol is exported for use by clients
87 // For every "mDNSexport" in a C file, there needs to be a corresponding "extern" declaration in some header file
88 // (When a C file #includes a header file, the "extern" declarations tell the compiler:
89 // "This symbol exists -- but not necessarily in this C file.")
90 #ifndef mDNSexport
91 #define mDNSexport
92 #endif
93
94 // Explanation: These local/export markers are a little habit of mine for signaling the programmers' intentions.
95 // When "mDNSlocal" is just a synonym for "static", and "mDNSexport" is a complete no-op, you could be
96 // forgiven for asking what purpose they serve. The idea is that if you see "mDNSexport" in front of a
97 // function definition it means the programmer intended it to be exported and callable from other files
98 // in the project. If you see "mDNSlocal" in front of a function definition it means the programmer
99 // intended it to be private to that file. If you see neither in front of a function definition it
100 // means the programmer forgot (so you should work out which it is supposed to be, and fix it).
101 // Using "mDNSlocal" instead of "static" makes it easier to do a textual searches for one or the other.
102 // For example you can do a search for "static" to find if any functions declare any local variables as "static"
103 // (generally a bad idea unless it's also "const", because static storage usually risks being non-thread-safe)
104 // without the results being cluttered with hundreds of matches for functions declared static.
105 // - Stuart Cheshire
106
107 // ***************************************************************************
108 // Structure packing macro
109
110 // If we're not using GNUC, it's not fatal.
111 // Most compilers naturally pack the on-the-wire structures correctly anyway, so a plain "struct" is usually fine.
112 // In the event that structures are not packed correctly, mDNS_Init() will detect this and report an error, so the
113 // developer will know what's wrong, and can investigate what needs to be done on that compiler to provide proper packing.
114 #ifndef packedstruct
115  #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
116   #define packedstruct struct __attribute__((__packed__))
117   #define packedunion  union  __attribute__((__packed__))
118  #else
119   #define packedstruct struct
120   #define packedunion  union
121  #endif
122 #endif
123
124 // ***************************************************************************
125 #if 0
126 #pragma mark - DNS Resource Record class and type constants
127 #endif
128
129 typedef enum                                                    // From RFC 1035
130         {
131         kDNSClass_IN               = 1,         // Internet
132         kDNSClass_CS               = 2,         // CSNET
133         kDNSClass_CH               = 3,         // CHAOS
134         kDNSClass_HS               = 4,         // Hesiod
135         kDNSClass_NONE             = 254,       // Used in DNS UPDATE [RFC 2136]
136
137         kDNSClass_Mask             = 0x7FFF,// Multicast DNS uses the bottom 15 bits to identify the record class...
138         kDNSClass_UniqueRRSet      = 0x8000,// ... and the top bit indicates that all other cached records are now invalid
139
140         kDNSQClass_ANY             = 255,       // Not a DNS class, but a DNS query class, meaning "all classes"
141         kDNSQClass_UnicastResponse = 0x8000     // Top bit set in a question means "unicast response acceptable"
142         } DNS_ClassValues;
143
144 typedef enum                            // From RFC 1035
145         {
146         kDNSType_A = 1,                 //  1 Address
147         kDNSType_NS,                    //  2 Name Server
148         kDNSType_MD,                    //  3 Mail Destination
149         kDNSType_MF,                    //  4 Mail Forwarder
150         kDNSType_CNAME,                 //  5 Canonical Name
151         kDNSType_SOA,                   //  6 Start of Authority
152         kDNSType_MB,                    //  7 Mailbox
153         kDNSType_MG,                    //  8 Mail Group
154         kDNSType_MR,                    //  9 Mail Rename
155         kDNSType_NULL,                  // 10 NULL RR
156         kDNSType_WKS,                   // 11 Well-known-service
157         kDNSType_PTR,                   // 12 Domain name pointer
158         kDNSType_HINFO,                 // 13 Host information
159         kDNSType_MINFO,                 // 14 Mailbox information
160         kDNSType_MX,                    // 15 Mail Exchanger
161         kDNSType_TXT,                   // 16 Arbitrary text string
162         kDNSType_RP,                    // 17 Responsible person
163         kDNSType_AFSDB,                 // 18 AFS cell database
164         kDNSType_X25,                   // 19 X_25 calling address
165         kDNSType_ISDN,                  // 20 ISDN calling address
166         kDNSType_RT,                    // 21 Router
167         kDNSType_NSAP,                  // 22 NSAP address
168         kDNSType_NSAP_PTR,              // 23 Reverse NSAP lookup (deprecated)
169         kDNSType_SIG,                   // 24 Security signature
170         kDNSType_KEY,                   // 25 Security key
171         kDNSType_PX,                    // 26 X.400 mail mapping
172         kDNSType_GPOS,                  // 27 Geographical position (withdrawn)
173         kDNSType_AAAA,                  // 28 IPv6 Address
174         kDNSType_LOC,                   // 29 Location Information
175         kDNSType_NXT,                   // 30 Next domain (security)
176         kDNSType_EID,                   // 31 Endpoint identifier
177         kDNSType_NIMLOC,                // 32 Nimrod Locator
178         kDNSType_SRV,                   // 33 Service record
179         kDNSType_ATMA,                  // 34 ATM Address
180         kDNSType_NAPTR,                 // 35 Naming Authority PoinTeR
181         kDNSType_KX,                    // 36 Key Exchange
182         kDNSType_CERT,                  // 37 Certification record
183         kDNSType_A6,                    // 38 IPv6 Address (deprecated)
184         kDNSType_DNAME,                 // 39 Non-terminal DNAME (for IPv6)
185         kDNSType_SINK,                  // 40 Kitchen sink (experimental)
186         kDNSType_OPT,                   // 41 EDNS0 option (meta-RR)
187         kDNSType_APL,                   // 42 Address Prefix List
188         kDNSType_DS,                    // 43 Delegation Signer
189         kDNSType_SSHFP,                 // 44 SSH Key Fingerprint
190         kDNSType_IPSECKEY,              // 45 IPSECKEY
191         kDNSType_RRSIG,                 // 46 RRSIG
192         kDNSType_NSEC,                  // 47 Denial of Existence
193         kDNSType_DNSKEY,                // 48 DNSKEY
194         kDNSType_DHCID,                 // 49 DHCP Client Identifier
195         kDNSType_NSEC3,                 // 50 Hashed Authenticated Denial of Existence
196         kDNSType_NSEC3PARAM,    // 51 Hashed Authenticated Denial of Existence
197
198         kDNSType_HIP = 55,              // 55 Host Identity Protocol
199
200         kDNSType_SPF = 99,              // 99 Sender Policy Framework for E-Mail
201         kDNSType_UINFO,                 // 100 IANA-Reserved
202         kDNSType_UID,                   // 101 IANA-Reserved
203         kDNSType_GID,                   // 102 IANA-Reserved
204         kDNSType_UNSPEC,                // 103 IANA-Reserved
205
206         kDNSType_TKEY = 249,    // 249 Transaction key
207         kDNSType_TSIG,                  // 250 Transaction signature
208         kDNSType_IXFR,                  // 251 Incremental zone transfer
209         kDNSType_AXFR,                  // 252 Transfer zone of authority
210         kDNSType_MAILB,                 // 253 Transfer mailbox records
211         kDNSType_MAILA,                 // 254 Transfer mail agent records
212         kDNSQType_ANY                   // Not a DNS type, but a DNS query type, meaning "all types"
213         } DNS_TypeValues;
214
215 // ***************************************************************************
216 #if 0
217 #pragma mark -
218 #pragma mark - Simple types
219 #endif
220
221 // mDNS defines its own names for these common types to simplify portability across
222 // multiple platforms that may each have their own (different) names for these types.
223 typedef          int   mDNSBool;
224 typedef   signed char  mDNSs8;
225 typedef unsigned char  mDNSu8;
226 typedef   signed short mDNSs16;
227 typedef unsigned short mDNSu16;
228
229 // <http://gcc.gnu.org/onlinedocs/gcc-3.3.3/cpp/Common-Predefined-Macros.html> says
230 //   __LP64__ _LP64
231 //   These macros are defined, with value 1, if (and only if) the compilation is
232 //   for a target where long int and pointer both use 64-bits and int uses 32-bit.
233 // <http://www.intel.com/software/products/compilers/clin/docs/ug/lin1077.htm> says
234 //   Macro Name __LP64__ Value 1
235 // A quick Google search for "defined(__LP64__)" OR "#ifdef __LP64__" gives 2590 hits and
236 // a search for "#if __LP64__" gives only 12, so I think we'll go with the majority and use defined()
237 #if defined(_ILP64) || defined(__ILP64__)
238 typedef   signed int32 mDNSs32;
239 typedef unsigned int32 mDNSu32;
240 #elif defined(_LP64) || defined(__LP64__)
241 typedef   signed int   mDNSs32;
242 typedef unsigned int   mDNSu32;
243 #else
244 typedef   signed long  mDNSs32;
245 typedef unsigned long  mDNSu32;
246 //typedef   signed int mDNSs32;
247 //typedef unsigned int mDNSu32;
248 #endif
249
250 // To enforce useful type checking, we make mDNSInterfaceID be a pointer to a dummy struct
251 // This way, mDNSInterfaceIDs can be assigned, and compared with each other, but not with other types
252 // Declaring the type to be the typical generic "void *" would lack this type checking
253 typedef struct mDNSInterfaceID_dummystruct { void *dummy; } *mDNSInterfaceID;
254
255 // These types are for opaque two- and four-byte identifiers.
256 // The "NotAnInteger" fields of the unions allow the value to be conveniently passed around in a
257 // register for the sake of efficiency, and compared for equality or inequality, but don't forget --
258 // just because it is in a register doesn't mean it is an integer. Operations like greater than,
259 // less than, add, multiply, increment, decrement, etc., are undefined for opaque identifiers,
260 // and if you make the mistake of trying to do those using the NotAnInteger field, then you'll
261 // find you get code that doesn't work consistently on big-endian and little-endian machines.
262 #if defined(_WIN32)
263  #pragma pack(push,2)
264 #endif
265 typedef       union { mDNSu8 b[ 2]; mDNSu16 NotAnInteger; } mDNSOpaque16;
266 typedef       union { mDNSu8 b[ 4]; mDNSu32 NotAnInteger; } mDNSOpaque32;
267 typedef packedunion { mDNSu8 b[ 6]; mDNSu16 w[3]; mDNSu32 l[1]; } mDNSOpaque48;
268 typedef       union { mDNSu8 b[ 8]; mDNSu16 w[4]; mDNSu32 l[2]; } mDNSOpaque64;
269 typedef       union { mDNSu8 b[16]; mDNSu16 w[8]; mDNSu32 l[4]; } mDNSOpaque128;
270 #if defined(_WIN32)
271  #pragma pack(pop)
272 #endif
273
274 typedef mDNSOpaque16  mDNSIPPort;               // An IP port is a two-byte opaque identifier (not an integer)
275 typedef mDNSOpaque32  mDNSv4Addr;               // An IP address is a four-byte opaque identifier (not an integer)
276 typedef mDNSOpaque128 mDNSv6Addr;               // An IPv6 address is a 16-byte opaque identifier (not an integer)
277 typedef mDNSOpaque48  mDNSEthAddr;              // An Ethernet address is a six-byte opaque identifier (not an integer)
278
279 enum
280         {
281         mDNSAddrType_None    = 0,
282         mDNSAddrType_IPv4    = 4,
283         mDNSAddrType_IPv6    = 6,
284         mDNSAddrType_Unknown = ~0       // Special marker value used in known answer list recording
285         };
286
287 enum
288         {
289         mDNSTransport_None = 0,
290         mDNSTransport_UDP  = 1,
291         mDNSTransport_TCP  = 2
292         };
293
294 typedef struct
295         {
296         mDNSs32 type;
297         union { mDNSv6Addr v6; mDNSv4Addr v4; } ip;
298         } mDNSAddr;
299
300 enum { mDNSfalse = 0, mDNStrue = 1 };
301
302 #define mDNSNULL 0L
303
304 enum
305         {
306         mStatus_Waiting           = 1,
307         mStatus_NoError           = 0,
308
309         // mDNS return values are in the range FFFE FF00 (-65792) to FFFE FFFF (-65537)
310         // The top end of the range (FFFE FFFF) is used for error codes;
311         // the bottom end of the range (FFFE FF00) is used for non-error values;
312
313         // Error codes:
314         mStatus_UnknownErr                = -65537,             // First value: 0xFFFE FFFF
315         mStatus_NoSuchNameErr             = -65538,
316         mStatus_NoMemoryErr               = -65539,
317         mStatus_BadParamErr               = -65540,
318         mStatus_BadReferenceErr           = -65541,
319         mStatus_BadStateErr               = -65542,
320         mStatus_BadFlagsErr               = -65543,
321         mStatus_UnsupportedErr            = -65544,
322         mStatus_NotInitializedErr         = -65545,
323         mStatus_NoCache                   = -65546,
324         mStatus_AlreadyRegistered         = -65547,
325         mStatus_NameConflict              = -65548,
326         mStatus_Invalid                   = -65549,
327         mStatus_Firewall                  = -65550,
328         mStatus_Incompatible              = -65551,
329         mStatus_BadInterfaceErr           = -65552,
330         mStatus_Refused                   = -65553,
331         mStatus_NoSuchRecord              = -65554,
332         mStatus_NoAuth                    = -65555,
333         mStatus_NoSuchKey                 = -65556,
334         mStatus_NATTraversal              = -65557,
335         mStatus_DoubleNAT                 = -65558,
336         mStatus_BadTime                   = -65559,
337         mStatus_BadSig                    = -65560,     // while we define this per RFC 2845, BIND 9 returns Refused for bad/missing signatures
338         mStatus_BadKey                    = -65561,
339         mStatus_TransientErr              = -65562,     // transient failures, e.g. sending packets shortly after a network transition or wake from sleep
340         mStatus_ServiceNotRunning         = -65563,     // Background daemon not running
341         mStatus_NATPortMappingUnsupported = -65564,     // NAT doesn't support NAT-PMP or UPnP
342         mStatus_NATPortMappingDisabled    = -65565,     // NAT supports NAT-PMP or UPnP but it's disabled by the administrator
343         mStatus_NoRouter                  = -65566,
344         mStatus_PollingMode               = -65567,
345         // -65568 to -65786 currently unused; available for allocation
346
347         // tcp connection status
348         mStatus_ConnPending       = -65787,
349         mStatus_ConnFailed        = -65788,
350         mStatus_ConnEstablished   = -65789,
351
352         // Non-error values:
353         mStatus_GrowCache         = -65790,
354         mStatus_ConfigChanged     = -65791,
355         mStatus_MemFree           = -65792              // Last value: 0xFFFE FF00
356         // mStatus_MemFree is the last legal mDNS error code, at the end of the range allocated for mDNS
357         };
358
359 typedef mDNSs32 mStatus;
360
361 // RFC 1034/1035 specify that a domain label consists of a length byte plus up to 63 characters
362 #define MAX_DOMAIN_LABEL 63
363 typedef struct { mDNSu8 c[ 64]; } domainlabel;          // One label: length byte and up to 63 characters
364
365 // RFC 1034/1035/2181 specify that a domain name, including length bytes, data bytes, and terminating zero, may be up to 256 bytes long
366 #define MAX_DOMAIN_NAME 256
367 typedef struct { mDNSu8 c[256]; } domainname;           // Up to 256 bytes of length-prefixed domainlabels
368
369 typedef struct { mDNSu8 c[256]; } UTF8str255;           // Null-terminated C string
370
371 // The longest legal textual form of a DNS name is 1009 bytes, including the C-string terminating NULL at the end.
372 // Explanation:
373 // When a native domainname object is converted to printable textual form using ConvertDomainNameToCString(),
374 // non-printing characters are represented in the conventional DNS way, as '\ddd', where ddd is a three-digit decimal number.
375 // The longest legal domain name is 256 bytes, in the form of four labels as shown below:
376 // Length byte, 63 data bytes, length byte, 63 data bytes, length byte, 63 data bytes, length byte, 62 data bytes, zero byte.
377 // Each label is encoded textually as characters followed by a trailing dot.
378 // If every character has to be represented as a four-byte escape sequence, then this makes the maximum textual form four labels
379 // plus the C-string terminating NULL as shown below:
380 // 63*4+1 + 63*4+1 + 63*4+1 + 62*4+1 + 1 = 1009.
381 // Note that MAX_ESCAPED_DOMAIN_LABEL is not normally used: If you're only decoding a single label, escaping is usually not required.
382 // It is for domain names, where dots are used as label separators, that proper escaping is vital.
383 #define MAX_ESCAPED_DOMAIN_LABEL 254
384 #define MAX_ESCAPED_DOMAIN_NAME 1009
385
386 // MAX_REVERSE_MAPPING_NAME
387 // For IPv4: "123.123.123.123.in-addr.arpa."  30 bytes including terminating NUL
388 // For IPv6: "x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.ip6.arpa."  74 bytes including terminating NUL
389
390 #define MAX_REVERSE_MAPPING_NAME_V4 30
391 #define MAX_REVERSE_MAPPING_NAME_V6 74
392 #define MAX_REVERSE_MAPPING_NAME    74
393
394 // Most records have a TTL of 75 minutes, so that their 80% cache-renewal query occurs once per hour.
395 // For records containing a hostname (in the name on the left, or in the rdata on the right),
396 // like A, AAAA, reverse-mapping PTR, and SRV, we use a two-minute TTL by default, because we don't want
397 // them to hang around for too long in the cache if the host in question crashes or otherwise goes away.
398
399 #define kStandardTTL (3600UL * 100 / 80)
400 #define kHostNameTTL 120UL
401
402 #define DefaultTTLforRRType(X) (((X) == kDNSType_A || (X) == kDNSType_AAAA || (X) == kDNSType_SRV) ? kHostNameTTL : kStandardTTL)
403
404 typedef struct AuthRecord_struct AuthRecord;
405 typedef struct ServiceRecordSet_struct ServiceRecordSet;
406 typedef struct CacheRecord_struct CacheRecord;
407 typedef struct CacheGroup_struct CacheGroup;
408 typedef struct DNSQuestion_struct DNSQuestion;
409 typedef struct ZoneData_struct ZoneData;
410 typedef struct mDNS_struct mDNS;
411 typedef struct mDNS_PlatformSupport_struct mDNS_PlatformSupport;
412 typedef struct NATTraversalInfo_struct NATTraversalInfo;
413
414 // Structure to abstract away the differences between TCP/SSL sockets, and one for UDP sockets
415 // The actual definition of these structures appear in the appropriate platform support code
416 typedef struct TCPSocket_struct TCPSocket;
417 typedef struct UDPSocket_struct UDPSocket;
418
419 // ***************************************************************************
420 #if 0
421 #pragma mark -
422 #pragma mark - DNS Message structures
423 #endif
424
425 #define mDNS_numZones   numQuestions
426 #define mDNS_numPrereqs numAnswers
427 #define mDNS_numUpdates numAuthorities
428
429 typedef packedstruct
430         {
431         mDNSOpaque16 id;
432         mDNSOpaque16 flags;
433         mDNSu16 numQuestions;
434         mDNSu16 numAnswers;
435         mDNSu16 numAuthorities;
436         mDNSu16 numAdditionals;
437         } DNSMessageHeader;
438
439 // We can send and receive packets up to 9000 bytes (Ethernet Jumbo Frame size, if that ever becomes widely used)
440 // However, in the normal case we try to limit packets to 1500 bytes so that we don't get IP fragmentation on standard Ethernet
441 // 40 (IPv6 header) + 8 (UDP header) + 12 (DNS message header) + 1440 (DNS message body) = 1500 total
442 #define AbsoluteMaxDNSMessageData 8940
443 #define NormalMaxDNSMessageData 1440
444 typedef packedstruct
445         {
446         DNSMessageHeader h;                                             // Note: Size 12 bytes
447         mDNSu8 data[AbsoluteMaxDNSMessageData]; // 40 (IPv6) + 8 (UDP) + 12 (DNS header) + 8940 (data) = 9000
448         } DNSMessage;
449
450 typedef struct tcpInfo_t
451         {
452         mDNS             *m;
453         TCPSocket        *sock;
454         DNSMessage        request;
455         int               requestLen;
456         DNSQuestion      *question;   // For queries
457         ServiceRecordSet *srs;        // For service record updates
458         AuthRecord       *rr;         // For record updates
459         mDNSAddr          Addr;
460         mDNSIPPort        Port;
461         DNSMessage       *reply;
462         mDNSu16           replylen;
463         unsigned long     nread;
464         int               numReplies;
465         } tcpInfo_t;
466
467 // ***************************************************************************
468 #if 0
469 #pragma mark -
470 #pragma mark - Other Packet Format Structures
471 #endif
472
473 typedef packedstruct
474         {
475         mDNSEthAddr  dst;
476         mDNSEthAddr  src;
477         mDNSOpaque16 ethertype;
478         } EthernetHeader;               // 14 bytes
479
480 typedef packedstruct
481         {
482         mDNSOpaque16 hrd;
483         mDNSOpaque16 pro;
484         mDNSu8       hln;
485         mDNSu8       pln;
486         mDNSOpaque16 op;
487         mDNSEthAddr  sha;
488         mDNSv4Addr   spa;
489         mDNSEthAddr  tha;
490         mDNSv4Addr   tpa;
491         } ARP_EthIP;                    // 28 bytes
492
493 typedef packedstruct
494         {
495         mDNSu8       vlen;
496         mDNSu8       tos;
497         mDNSu16      totlen;
498         mDNSOpaque16 id;
499         mDNSOpaque16 flagsfrags;
500         mDNSu8       ttl;
501         mDNSu8       protocol;
502         mDNSu16      checksum;
503         mDNSv4Addr   src;
504         mDNSv4Addr   dst;
505         } IPv4Header;                   // 20 bytes
506
507 typedef packedstruct
508         {
509         mDNSu32      vcf;               // Version, Traffic Class, Flow Label
510         mDNSu16      len;               // Payload Length
511         mDNSu8       protocol;  // Type of next header: 0x06 = TCP, 0x11 = UDP, 0x3A = ICMPv6
512         mDNSu8       ttl;               // Hop Limit
513         mDNSv6Addr   src;
514         mDNSv6Addr   dst;
515         } IPv6Header;                   // 40 bytes
516
517 typedef packedstruct
518         {
519         mDNSu8       type;              // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement
520         mDNSu8       code;
521         mDNSu16      checksum;
522         mDNSu32      reserved;
523         mDNSv6Addr   target;
524         } IPv6ND;                               // 24 bytes
525
526 typedef packedstruct
527         {
528         mDNSIPPort   src;
529         mDNSIPPort   dst;
530         mDNSu16      len;               // Length including UDP header (ie. minimum value is 8 bytes)
531         mDNSu16      checksum;
532         } UDPHeader;                    // 8 bytes
533
534 typedef packedstruct
535         {
536         mDNSOpaque64 InitiatorCookie;
537         mDNSOpaque64 ResponderCookie;
538         mDNSu8       NextPayload;
539         mDNSu8       Version;
540         mDNSu8       ExchangeType;
541         mDNSu8       Flags;
542         mDNSOpaque32 MessageID;
543         mDNSu32      Length;
544         } IKEHeader;                    // 28 bytes
545
546 typedef packedstruct
547         {
548         mDNSIPPort   src;
549         mDNSIPPort   dst;
550         mDNSu32      seq;
551         mDNSu32      ack;
552         mDNSu8       offset;
553         mDNSu8       flags;
554         mDNSu16      window;
555         mDNSu16      checksum;
556         mDNSu16      urgent;
557         } TCPHeader;                    // 20 bytes
558
559 // ***************************************************************************
560 #if 0
561 #pragma mark -
562 #pragma mark - Resource Record structures
563 #endif
564
565 // Authoritative Resource Records:
566 // There are four basic types: Shared, Advisory, Unique, Known Unique
567
568 // * Shared Resource Records do not have to be unique
569 // -- Shared Resource Records are used for DNS-SD service PTRs
570 // -- It is okay for several hosts to have RRs with the same name but different RDATA
571 // -- We use a random delay on responses to reduce collisions when all the hosts respond to the same query
572 // -- These RRs typically have moderately high TTLs (e.g. one hour)
573 // -- These records are announced on startup and topology changes for the benefit of passive listeners
574 // -- These records send a goodbye packet when deregistering
575 //
576 // * Advisory Resource Records are like Shared Resource Records, except they don't send a goodbye packet
577 //
578 // * Unique Resource Records should be unique among hosts within any given mDNS scope
579 // -- The majority of Resource Records are of this type
580 // -- If two entities on the network have RRs with the same name but different RDATA, this is a conflict
581 // -- Responses may be sent immediately, because only one host should be responding to any particular query
582 // -- These RRs typically have low TTLs (e.g. a few minutes)
583 // -- On startup and after topology changes, a host issues queries to verify uniqueness
584
585 // * Known Unique Resource Records are treated like Unique Resource Records, except that mDNS does
586 // not have to verify their uniqueness because this is already known by other means (e.g. the RR name
587 // is derived from the host's IP or Ethernet address, which is already known to be a unique identifier).
588
589 // Summary of properties of different record types:
590 // Probe?    Does this record type send probes before announcing?
591 // Conflict? Does this record type react if we observe an apparent conflict?
592 // Goodbye?  Does this record type send a goodbye packet on departure?
593 //
594 //               Probe? Conflict? Goodbye? Notes
595 // Unregistered                            Should not appear in any list (sanity check value)
596 // Shared         No      No       Yes     e.g. Service PTR record
597 // Deregistering  No      No       Yes     Shared record about to announce its departure and leave the list
598 // Advisory       No      No       No
599 // Unique         Yes     Yes      No      Record intended to be unique -- will probe to verify
600 // Verified       Yes     Yes      No      Record has completed probing, and is verified unique
601 // KnownUnique    No      Yes      No      Record is assumed by other means to be unique
602
603 // Valid lifecycle of a record:
604 // Unregistered ->                   Shared      -> Deregistering -(goodbye)-> Unregistered
605 // Unregistered ->                   Advisory                               -> Unregistered
606 // Unregistered -> Unique -(probe)-> Verified                               -> Unregistered
607 // Unregistered ->                   KnownUnique                            -> Unregistered
608
609 // Each Authoritative kDNSRecordType has only one bit set. This makes it easy to quickly see if a record
610 // is one of a particular set of types simply by performing the appropriate bitwise masking operation.
611
612 // Cache Resource Records (received from the network):
613 // There are four basic types: Answer, Unique Answer, Additional, Unique Additional
614 // Bit 7 (the top bit) of kDNSRecordType is always set for Cache Resource Records; always clear for Authoritative Resource Records
615 // Bit 6 (value 0x40) is set for answer records; clear for authority/additional records
616 // Bit 5 (value 0x20) is set for records received with the kDNSClass_UniqueRRSet
617
618 enum
619         {
620         kDNSRecordTypeUnregistered     = 0x00,  // Not currently in any list
621         kDNSRecordTypeDeregistering    = 0x01,  // Shared record about to announce its departure and leave the list
622
623         kDNSRecordTypeUnique           = 0x02,  // Will become a kDNSRecordTypeVerified when probing is complete
624
625         kDNSRecordTypeAdvisory         = 0x04,  // Like Shared, but no goodbye packet
626         kDNSRecordTypeShared           = 0x08,  // Shared means record name does not have to be unique -- use random delay on responses
627
628         kDNSRecordTypeVerified         = 0x10,  // Unique means mDNS should check that name is unique (and then send immediate responses)
629         kDNSRecordTypeKnownUnique      = 0x20,  // Known Unique means mDNS can assume name is unique without checking
630                                                 // For Dynamic Update records, Known Unique means the record must already exist on the server.
631         kDNSRecordTypeUniqueMask       = (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique),
632         kDNSRecordTypeActiveMask       = (kDNSRecordTypeAdvisory | kDNSRecordTypeShared | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique),
633
634         kDNSRecordTypePacketAdd        = 0x80,  // Received in the Additional  Section of a DNS Response
635         kDNSRecordTypePacketAddUnique  = 0x90,  // Received in the Additional  Section of a DNS Response with kDNSClass_UniqueRRSet set
636         kDNSRecordTypePacketAuth       = 0xA0,  // Received in the Authorities Section of a DNS Response
637         kDNSRecordTypePacketAuthUnique = 0xB0,  // Received in the Authorities Section of a DNS Response with kDNSClass_UniqueRRSet set
638         kDNSRecordTypePacketAns        = 0xC0,  // Received in the Answer      Section of a DNS Response
639         kDNSRecordTypePacketAnsUnique  = 0xD0,  // Received in the Answer      Section of a DNS Response with kDNSClass_UniqueRRSet set
640
641         kDNSRecordTypePacketNegative   = 0xF0,  // Pseudo-RR generated to cache non-existence results like NXDomain
642
643         kDNSRecordTypePacketUniqueMask = 0x10   // True for PacketAddUnique, PacketAnsUnique, PacketAuthUnique
644         };
645
646 typedef packedstruct { mDNSu16 priority; mDNSu16 weight; mDNSIPPort port; domainname target;   } rdataSRV;
647 typedef packedstruct { mDNSu16 preference;                                domainname exchange; } rdataMX;
648 typedef packedstruct { domainname mbox; domainname txt;                                        } rdataRP;
649 typedef packedstruct { mDNSu16 preference; domainname map822; domainname mapx400;              } rdataPX;
650
651 typedef packedstruct
652         {
653         domainname mname;
654         domainname rname;
655         mDNSs32 serial;         // Modular counter; increases when zone changes
656         mDNSu32 refresh;        // Time in seconds that a slave waits after successful replication of the database before it attempts replication again
657         mDNSu32 retry;          // Time in seconds that a slave waits after an unsuccessful replication attempt before it attempts replication again
658         mDNSu32 expire;         // Time in seconds that a slave holds on to old data while replication attempts remain unsuccessful
659         mDNSu32 min;            // Nominally the minimum record TTL for this zone, in seconds; also used for negative caching.
660         } rdataSOA;
661
662 // EDNS Option Code registrations are recorded in the "DNS EDNS0 Options" section of
663 // <http://www.iana.org/assignments/dns-parameters>
664
665 #define kDNSOpt_LLQ   1
666 #define kDNSOpt_Lease 2
667 #define kDNSOpt_NSID  3
668 #define kDNSOpt_Owner 4
669
670 typedef struct
671         {
672         mDNSu16      vers;
673         mDNSu16      llqOp;
674         mDNSu16      err;       // Or UDP reply port, in setup request
675         // Note: In the in-memory form, there's typically a two-byte space here, so that the following 64-bit id is word-aligned
676         mDNSOpaque64 id;
677         mDNSu32      llqlease;
678         } LLQOptData;
679
680 typedef struct
681         {
682         mDNSu8       vers;              // Version number of this Owner OPT record
683         mDNSs8       seq;               // Sleep/wake epoch
684         mDNSEthAddr  HMAC;              // Host's primary identifier (e.g. MAC of on-board Ethernet)
685         mDNSEthAddr  IMAC;              // Interface's MAC address (if different to primary MAC)
686         mDNSOpaque48 password;  // Optional password
687         } OwnerOptData;
688
689 // Note: rdataOPT format may be repeated an arbitrary number of times in a single resource record
690 typedef packedstruct
691         {
692         mDNSu16 opt;
693         mDNSu16 optlen;
694         union { LLQOptData llq; mDNSu32 updatelease; OwnerOptData owner; } u;
695         } rdataOPT;
696
697 // Space needed to put OPT records into a packet:
698 // Header      11 bytes (name 1, type 2, class 2, TTL 4, length 2)
699 // LLQ rdata   18 bytes (opt 2, len 2, vers 2, op 2, err 2, id 8, lease 4)
700 // Lease rdata  8 bytes (opt 2, len 2, lease 4)
701 // Owner rdata 12-24    (opt 2, len 2, owner 8-20)
702
703 #define DNSOpt_Header_Space                 11
704 #define DNSOpt_LLQData_Space               (4 + 2 + 2 + 2 + 8 + 4)
705 #define DNSOpt_LeaseData_Space             (4 + 4)
706 #define DNSOpt_OwnerData_ID_Space          (4 + 2 + 6)
707 #define DNSOpt_OwnerData_ID_Wake_Space     (4 + 2 + 6 + 6)
708 #define DNSOpt_OwnerData_ID_Wake_PW4_Space (4 + 2 + 6 + 6 + 4)
709 #define DNSOpt_OwnerData_ID_Wake_PW6_Space (4 + 2 + 6 + 6 + 6)
710
711 #define ValidOwnerLength(X) (   (X) == DNSOpt_OwnerData_ID_Space          - 4 || \
712                                                                 (X) == DNSOpt_OwnerData_ID_Wake_Space     - 4 || \
713                                                                 (X) == DNSOpt_OwnerData_ID_Wake_PW4_Space - 4 || \
714                                                                 (X) == DNSOpt_OwnerData_ID_Wake_PW6_Space - 4    )
715
716 #define ValidDNSOpt(O) (((O)->opt == kDNSOpt_LLQ   && (O)->optlen == DNSOpt_LLQData_Space   - 4) || \
717                                                 ((O)->opt == kDNSOpt_Lease && (O)->optlen == DNSOpt_LeaseData_Space - 4) || \
718                                                 ((O)->opt == kDNSOpt_Owner && ValidOwnerLength((O)->optlen)            )    )
719
720 #define DNSOpt_Owner_Space(A,B) (mDNSSameEthAddress((A),(B)) ? DNSOpt_OwnerData_ID_Space : DNSOpt_OwnerData_ID_Wake_Space)
721
722 #define DNSOpt_Data_Space(O) (                                  \
723         (O)->opt == kDNSOpt_LLQ   ? DNSOpt_LLQData_Space   :        \
724         (O)->opt == kDNSOpt_Lease ? DNSOpt_LeaseData_Space :        \
725         (O)->opt == kDNSOpt_Owner ? DNSOpt_Owner_Space(&(O)->u.owner.HMAC, &(O)->u.owner.IMAC) : 0x10000)
726
727 // A maximal NSEC record is:
728 //   256 bytes domainname 'nextname'
729 // + 256 * 34 = 8704 bytes of bitmap data
730 // = 8960 bytes total
731 // For now we only support NSEC records encoding DNS types 0-255 and ignore the nextname (we always set it to be the same as the rrname),
732 // which gives us a fixed in-memory size of 32 bytes (256 bits)
733 typedef struct
734         {
735         mDNSu8 bitmap[32];
736         } rdataNSEC;
737
738 // StandardAuthRDSize is 264 (256+8), which is large enough to hold a maximum-sized SRV record (6 + 256 bytes)
739 // MaximumRDSize is 8K the absolute maximum we support (at least for now)
740 #define StandardAuthRDSize 264
741 #define MaximumRDSize 8192
742
743 // InlineCacheRDSize is 68
744 // Records received from the network with rdata this size or less have their rdata stored right in the CacheRecord object
745 // Records received from the network with rdata larger than this have additional storage allocated for the rdata
746 // A quick unscientific sample from a busy network at Apple with lots of machines revealed this:
747 // 1461 records in cache
748 // 292 were one-byte TXT records
749 // 136 were four-byte A records
750 // 184 were sixteen-byte AAAA records
751 // 780 were various PTR, TXT and SRV records from 12-64 bytes
752 // Only 69 records had rdata bigger than 64 bytes
753 // Note that since CacheRecord object and a CacheGroup object are allocated out of the same pool, it's sensible to
754 // have them both be the same size. Making one smaller without making the other smaller won't actually save any memory.
755 #define InlineCacheRDSize 68
756
757 // On 64-bit, the pointers in a CacheRecord are bigger, and that creates 8 bytes more space for the name in a CacheGroup
758 #if ENABLE_MULTI_PACKET_QUERY_SNOOPING
759         #if defined(_ILP64) || defined(__ILP64__) || defined(_LP64) || defined(__LP64__) || defined(_WIN64)
760         #define InlineCacheGroupNameSize 152
761         #else
762         #define InlineCacheGroupNameSize 144
763         #endif
764 #else
765         #if defined(_ILP64) || defined(__ILP64__) || defined(_LP64) || defined(__LP64__) || defined(_WIN64)
766         #define InlineCacheGroupNameSize 136
767         #else
768         #define InlineCacheGroupNameSize 128
769         #endif
770 #endif
771
772 // The RDataBody union defines the common rdata types that fit into our 264-byte limit
773 typedef union
774         {
775         mDNSu8      data[StandardAuthRDSize];
776         mDNSv4Addr  ipv4;               // For 'A' record
777         domainname  name;               // For PTR, NS, CNAME, DNAME
778         UTF8str255  txt;
779         rdataMX     mx;
780         mDNSv6Addr  ipv6;               // For 'AAAA' record
781         rdataSRV    srv;
782         rdataOPT    opt[2];             // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together
783         rdataNSEC   nsec;
784         } RDataBody;
785
786 // The RDataBody2 union is the same as above, except it includes fields for the larger types like soa, rp, px
787 typedef union
788         {
789         mDNSu8      data[StandardAuthRDSize];
790         mDNSv4Addr  ipv4;               // For 'A' record
791         domainname  name;               // For PTR, NS, CNAME, DNAME
792         rdataSOA    soa;                // This is large; not included in the normal RDataBody definition
793         UTF8str255  txt;
794         rdataMX     mx;
795         rdataRP     rp;                 // This is large; not included in the normal RDataBody definition
796         rdataPX     px;                 // This is large; not included in the normal RDataBody definition
797         mDNSv6Addr  ipv6;               // For 'AAAA' record
798         rdataSRV    srv;
799         rdataOPT    opt[2];             // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together
800         rdataNSEC   nsec;
801         } RDataBody2;
802
803 typedef struct
804         {
805         mDNSu16    MaxRDLength; // Amount of storage allocated for rdata (usually sizeof(RDataBody))
806         mDNSu16    padding;             // So that RDataBody is aligned on 32-bit boundary
807         RDataBody  u;
808         } RData;
809
810 // sizeofRDataHeader should be 4 bytes
811 #define sizeofRDataHeader (sizeof(RData) - sizeof(RDataBody))
812
813 // RData_small is a smaller version of the RData object, used for inline data storage embedded in a CacheRecord_struct
814 typedef struct
815         {
816         mDNSu16    MaxRDLength; // Storage allocated for data (may be greater than InlineCacheRDSize if additional storage follows this object)
817         mDNSu16    padding;             // So that data is aligned on 32-bit boundary
818         mDNSu8     data[InlineCacheRDSize];
819         } RData_small;
820
821 // Note: Within an mDNSRecordCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
822 typedef void mDNSRecordCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
823
824 // Note:
825 // Restrictions: An mDNSRecordUpdateCallback may not make any mDNS API calls.
826 // The intent of this callback is to allow the client to free memory, if necessary.
827 // The internal data structures of the mDNS code may not be in a state where mDNS API calls may be made safely.
828 typedef void mDNSRecordUpdateCallback(mDNS *const m, AuthRecord *const rr, RData *OldRData);
829
830 // ***************************************************************************
831 #if 0
832 #pragma mark -
833 #pragma mark - NAT Traversal structures and constants
834 #endif
835
836 #define NATMAP_MAX_RETRY_INTERVAL    ((mDNSPlatformOneSecond * 60) * 15)    // Max retry interval is 15 minutes
837 #define NATMAP_MIN_RETRY_INTERVAL     (mDNSPlatformOneSecond * 2)           // Min retry interval is 2 seconds
838 #define NATMAP_INIT_RETRY             (mDNSPlatformOneSecond / 4)           // start at 250ms w/ exponential decay
839 #define NATMAP_DEFAULT_LEASE          (60 * 60 * 2)                         // 2 hour lease life in seconds
840 #define NATMAP_VERS 0
841
842 typedef enum
843         {
844         NATOp_AddrRequest    = 0,
845         NATOp_MapUDP         = 1,
846         NATOp_MapTCP         = 2,
847         
848         NATOp_AddrResponse   = 0x80 | 0,
849         NATOp_MapUDPResponse = 0x80 | 1,
850         NATOp_MapTCPResponse = 0x80 | 2,
851         } NATOp_t;
852
853 enum
854         {
855         NATErr_None    = 0,
856         NATErr_Vers    = 1,
857         NATErr_Refused = 2,
858         NATErr_NetFail = 3,
859         NATErr_Res     = 4,
860         NATErr_Opcode  = 5
861         };
862
863 typedef mDNSu16 NATErr_t;
864
865 typedef packedstruct
866         {
867         mDNSu8 vers;
868         mDNSu8 opcode;
869         } NATAddrRequest;
870
871 typedef packedstruct
872         {
873         mDNSu8     vers;
874         mDNSu8     opcode;
875         mDNSu16    err;
876         mDNSu32    upseconds;           // Time since last NAT engine reboot, in seconds
877         mDNSv4Addr ExtAddr;
878         } NATAddrReply;
879
880 typedef packedstruct
881         {
882         mDNSu8 vers;
883         mDNSu8 opcode;
884         mDNSOpaque16 unused;
885         mDNSIPPort intport;
886         mDNSIPPort extport;
887         mDNSu32    NATReq_lease;
888         } NATPortMapRequest;
889
890 typedef packedstruct
891         {
892         mDNSu8     vers;
893         mDNSu8     opcode;
894         mDNSu16    err;
895         mDNSu32    upseconds;           // Time since last NAT engine reboot, in seconds
896         mDNSIPPort intport;
897         mDNSIPPort extport;
898         mDNSu32    NATRep_lease;
899         } NATPortMapReply;
900
901 typedef enum
902         {
903         LNTDiscoveryOp      = 1,
904         LNTExternalAddrOp   = 2,
905         LNTPortMapOp        = 3,
906         LNTPortMapDeleteOp  = 4
907         } LNTOp_t;
908
909 #define LNT_MAXBUFSIZE 8192
910 typedef struct tcpLNTInfo_struct tcpLNTInfo;
911 struct tcpLNTInfo_struct
912         {
913         tcpLNTInfo       *next;
914         mDNS             *m;
915         NATTraversalInfo *parentNATInfo;        // pointer back to the parent NATTraversalInfo
916         TCPSocket        *sock;
917         LNTOp_t           op;                           // operation performed using this connection
918         mDNSAddr          Address;                      // router address
919         mDNSIPPort        Port;                         // router port
920         mDNSs8           *Request;                      // xml request to router
921         int               requestLen;
922         mDNSs8           *Reply;                        // xml reply from router
923         int               replyLen;
924         unsigned long     nread;                        // number of bytes read so far
925         int               retries;                      // number of times we've tried to do this port mapping
926         };
927
928 typedef void (*NATTraversalClientCallback)(mDNS *m, NATTraversalInfo *n);
929
930 // if m->timenow <  ExpiryTime then we have an active mapping, and we'll renew halfway to expiry
931 // if m->timenow >= ExpiryTime then our mapping has expired, and we're trying to create one
932
933 struct NATTraversalInfo_struct
934         {
935         // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
936         NATTraversalInfo           *next;
937
938         mDNSs32                     ExpiryTime;                 // Time this mapping expires, or zero if no mapping
939         mDNSs32                     retryInterval;              // Current interval, between last packet we sent and the next one
940         mDNSs32                     retryPortMap;               // If Protocol is nonzero, time to send our next mapping packet
941         mStatus                     NewResult;                  // New error code; will be copied to Result just prior to invoking callback
942
943 #ifdef _LEGACY_NAT_TRAVERSAL_
944         tcpLNTInfo                  tcpInfo;                    // Legacy NAT traversal (UPnP) TCP connection
945 #endif
946
947         // Result fields: When the callback is invoked these fields contain the answers the client is looking for
948         // When the callback is invoked ExternalPort is *usually* set to be the same the same as RequestedPort, except:
949         // (a) When we're behind a NAT gateway with port mapping disabled, ExternalPort is reported as zero to
950         //     indicate that we don't currently have a working mapping (but RequestedPort retains the external port
951         //     we'd like to get, the next time we meet an accomodating NAT gateway willing to give us one).
952         // (b) When we have a routable non-RFC1918 address, we don't *need* a port mapping, so ExternalPort
953         //     is reported as the same as our InternalPort, since that is effectively our externally-visible port too.
954         //     Again, RequestedPort retains the external port we'd like to get the next time we find ourself behind a NAT gateway.
955         // To improve stability of port mappings, RequestedPort is updated any time we get a successful
956         // mapping response from the NAT-PMP or UPnP gateway. For example, if we ask for port 80, and
957         // get assigned port 81, then thereafter we'll contine asking for port 81.
958         mDNSInterfaceID             InterfaceID;
959         mDNSv4Addr                  ExternalAddress;    // Initially set to onesIPv4Addr, until first callback
960         mDNSIPPort                  ExternalPort;
961         mDNSu32                     Lifetime;
962         mStatus                     Result;
963
964         // Client API fields: The client must set up these fields *before* making any NAT traversal API calls
965         mDNSu8                      Protocol;                   // NATOp_MapUDP or NATOp_MapTCP, or zero if just requesting the external IP address
966         mDNSIPPort                  IntPort;                    // Client's internal port number (doesn't change)
967         mDNSIPPort                  RequestedPort;              // Requested external port; may be updated with actual value assigned by gateway
968         mDNSu32                     NATLease;                   // Requested lifetime in seconds (doesn't change)
969         NATTraversalClientCallback  clientCallback;
970         void                       *clientContext;
971         };
972
973 typedef struct                                                  // Size is 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit
974         {
975         mDNSu8           RecordType;            // See enum above
976         mDNSu16          rrtype;
977         mDNSu16          rrclass;
978         mDNSu32          rroriginalttl;         // In seconds
979         mDNSu16          rdlength;                      // Size of the raw rdata, in bytes, in the on-the-wire format
980                                                                                 // (In-memory storage may be larger, for structures containing 'holes', like SOA,
981                                                                                 // or smaller, for NSEC where we don't bother storing the nextname field)
982         mDNSu16          rdestimate;            // Upper bound on on-the-wire size of rdata after name compression
983         mDNSu32          namehash;                      // Name-based (i.e. case-insensitive) hash of name
984         mDNSu32          rdatahash;                     // For rdata containing domain name (e.g. PTR, SRV, CNAME etc.), case-insensitive name hash
985                                                                                 // else, for all other rdata, 32-bit hash of the raw rdata
986                                                                                 // Note: This requirement is important. Various routines like AddAdditionalsToResponseList(),
987                                                                                 // ReconfirmAntecedents(), etc., use rdatahash as a pre-flight check to see
988                                                                                 // whether it's worth doing a full SameDomainName() call. If the rdatahash
989                                                                                 // is not a correct case-insensitive name hash, they'll get false negatives.
990
991         // Grouping pointers together at the end of the structure improves the memory layout efficiency
992         mDNSInterfaceID  InterfaceID;           // Set if this RR is specific to one interface
993                                                                                 // For records received off the wire, InterfaceID is *always* set to the receiving interface
994                                                                                 // For our authoritative records, InterfaceID is usually zero, except for those few records
995                                                                                 // that are interface-specific (e.g. address records, especially linklocal addresses)
996         const domainname *name;
997         RData           *rdata;                         // Pointer to storage for this rdata
998         } ResourceRecord;
999
1000 // Unless otherwise noted, states may apply to either independent record registrations or service registrations
1001 typedef enum
1002         {
1003         regState_Zero              = 0,
1004         regState_FetchingZoneData  = 1,     // getting info - update not sent
1005         regState_Pending           = 2,     // update sent, reply not received
1006         regState_Registered        = 3,     // update sent, reply received
1007         regState_DeregPending      = 4,     // dereg sent, reply not received
1008         regState_DeregDeferred     = 5,     // dereg requested while in Pending state - send dereg AFTER registration is confirmed
1009         regState_Unregistered      = 8,     // not in any list
1010         regState_Refresh           = 9,     // outstanding refresh (or target change) message
1011         regState_NATMap            = 10,    // establishing NAT port mapping (service registrations only)
1012         regState_UpdatePending     = 11,    // update in flight as result of mDNS_Update call
1013         regState_NoTarget          = 12,    // service registration pending registration of hostname (ServiceRegistrations only)
1014         regState_ExtraQueued       = 13,    // extra record to be registered upon completion of service registration (RecordRegistrations only)
1015         regState_NATError          = 14     // unable to complete NAT traversal
1016         } regState_t;
1017
1018 enum
1019         {
1020         Target_Manual = 0,
1021         Target_AutoHost = 1,
1022         Target_AutoHostAndNATMAP = 2
1023         };
1024
1025 struct AuthRecord_struct
1026         {
1027         // For examples of how to set up this structure for use in mDNS_Register(),
1028         // see mDNS_AdvertiseInterface() or mDNS_RegisterService().
1029         // Basically, resrec and persistent metadata need to be set up before calling mDNS_Register().
1030         // mDNS_SetupResourceRecord() is avaliable as a helper routine to set up most fields to sensible default values for you
1031
1032         AuthRecord     *next;                           // Next in list; first element of structure for efficiency reasons
1033         // Field Group 1: Common ResourceRecord fields
1034         ResourceRecord  resrec;                         // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit
1035
1036         // Field Group 2: Persistent metadata for Authoritative Records
1037         AuthRecord     *Additional1;            // Recommended additional record to include in response (e.g. SRV for PTR record)
1038         AuthRecord     *Additional2;            // Another additional (e.g. TXT for PTR record)
1039         AuthRecord     *DependentOn;            // This record depends on another for its uniqueness checking
1040         AuthRecord     *RRSet;                          // This unique record is part of an RRSet
1041         mDNSRecordCallback *RecordCallback;     // Callback function to call for state changes, and to free memory asynchronously on deregistration
1042         void           *RecordContext;          // Context parameter for the callback function
1043         mDNSu8          AutoTarget;                     // Set if the target of this record (PTR, CNAME, SRV, etc.) is our host name
1044         mDNSu8          AllowRemoteQuery;       // Set if we allow hosts not on the local link to query this record
1045         mDNSu8          ForceMCast;                     // Set by client to advertise solely via multicast, even for apparently unicast names
1046
1047         OwnerOptData    WakeUp;                         // Fpr Sleep Proxy records, MAC address of original owner (so we can wake it)
1048         mDNSAddr        AddressProxy;           // For reverse-mapping Sleep Proxy PTR records, address in question
1049         mDNSs32         TimeRcvd;                       // In platform time units
1050         mDNSs32         TimeExpire;                     // In platform time units
1051         
1052
1053         // Field Group 3: Transient state for Authoritative Records
1054         mDNSu8          Acknowledged;           // Set if we've given the success callback to the client
1055         mDNSu8          ProbeCount;                     // Number of probes remaining before this record is valid (kDNSRecordTypeUnique)
1056         mDNSu8          AnnounceCount;          // Number of announcements remaining (kDNSRecordTypeShared)
1057         mDNSu8          RequireGoodbye;         // Set if this RR has been announced on the wire and will require a goodbye packet
1058         mDNSu8          AnsweredLocalQ;         // Set if this AuthRecord has been delivered to any local question (LocalOnly or mDNSInterface_Any)
1059         mDNSu8          IncludeInProbe;         // Set if this RR is being put into a probe right now
1060         mDNSu8          ImmedUnicast;           // Set if we may send our response directly via unicast to the requester
1061         mDNSInterfaceID SendNSECNow;            // Set if we need to generate associated NSEC data for this rrname
1062         mDNSInterfaceID ImmedAnswer;            // Someone on this interface issued a query we need to answer (all-ones for all interfaces)
1063 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
1064         mDNSs32         ImmedAnswerMarkTime;
1065 #endif
1066         mDNSInterfaceID ImmedAdditional;        // Hint that we might want to also send this record, just to be helpful
1067         mDNSInterfaceID SendRNow;                       // The interface this query is being sent on right now
1068         mDNSv4Addr      v4Requester;            // Recent v4 query for this record, or all-ones if more than one recent query
1069         mDNSv6Addr      v6Requester;            // Recent v6 query for this record, or all-ones if more than one recent query
1070         AuthRecord     *NextResponse;           // Link to the next element in the chain of responses to generate
1071         const mDNSu8   *NR_AnswerTo;            // Set if this record was selected by virtue of being a direct answer to a question
1072         AuthRecord     *NR_AdditionalTo;        // Set if this record was selected by virtue of being additional to another
1073         mDNSs32         ThisAPInterval;         // In platform time units: Current interval for announce/probe
1074         mDNSs32         LastAPTime;                     // In platform time units: Last time we sent announcement/probe
1075         mDNSs32         LastMCTime;                     // Last time we multicast this record (used to guard against packet-storm attacks)
1076         mDNSInterfaceID LastMCInterface;        // Interface this record was multicast on at the time LastMCTime was recorded
1077         RData          *NewRData;                       // Set if we are updating this record with new rdata
1078         mDNSu16         newrdlength;            // ... and the length of the new RData
1079         mDNSRecordUpdateCallback *UpdateCallback;
1080         mDNSu32         UpdateCredits;          // Token-bucket rate limiting of excessive updates
1081         mDNSs32         NextUpdateCredit;       // Time next token is added to bucket
1082         mDNSs32         UpdateBlocked;          // Set if update delaying is in effect
1083
1084         // Field Group 4: Transient uDNS state for Authoritative Records
1085         regState_t   state;                     // Maybe combine this with resrec.RecordType state? Right now it's ambiguous and confusing.
1086                                                                 // e.g. rr->resrec.RecordType can be kDNSRecordTypeUnregistered,
1087                                                                 // and rr->state can be regState_Unregistered
1088                                                                 // What if we find one of those statements is true and the other false? What does that mean?
1089         mDNSBool     uselease;          // dynamic update contains (should contain) lease option
1090         mDNSs32      expire;            // In platform time units: expiration of lease (-1 for static)
1091         mDNSBool     Private;           // If zone is private, DNS updates may have to be encrypted to prevent eavesdropping
1092         mDNSOpaque16 updateid;          // Identifier to match update request and response -- also used when transferring records to Sleep Proxy
1093         const domainname *zone;         // the zone that is updated
1094         mDNSAddr     UpdateServer;      // DNS server that handles updates for this zone
1095         mDNSIPPort   UpdatePort;        // port on which server accepts dynamic updates
1096                                                                 // !!!KRS not technically correct to cache longer than TTL
1097                                                                 // SDC Perhaps should keep a reference to the relevant SRV record in the cache?
1098         ZoneData  *nta;
1099         struct tcpInfo_t *tcp;
1100
1101         // uDNS_UpdateRecord support fields
1102         // Do we really need all these in *addition* to NewRData and newrdlength above?
1103         mDNSu16 OrigRDLen;              // previously registered, being deleted
1104         mDNSu16 InFlightRDLen;  // currently being registered
1105         mDNSu16 QueuedRDLen;    // pending operation (re-transmitting if necessary) THEN register the queued update
1106         RData *OrigRData;
1107         RData *InFlightRData;
1108         RData *QueuedRData;
1109
1110         // Field Group 5: Large data objects go at the end
1111         domainname      namestorage;
1112         RData           rdatastorage;           // Normally the storage is right here, except for oversized records
1113         // rdatastorage MUST be the last thing in the structure -- when using oversized AuthRecords, extra bytes
1114         // are appended after the end of the AuthRecord, logically augmenting the size of the rdatastorage
1115         // DO NOT ADD ANY MORE FIELDS HERE
1116         };
1117
1118 #define AuthRecord_uDNS(R) ((R)->resrec.InterfaceID == mDNSInterface_Any && !(R)->ForceMCast && !IsLocalDomain((R)->resrec.name))
1119 #define Question_uDNS(Q)   ((Q)->InterfaceID == mDNSInterface_Any        && !(Q)->ForceMCast && !IsLocalDomain(&(Q)->qname))
1120
1121 // Wrapper struct for Auth Records for higher-level code that cannot use the AuthRecord's ->next pointer field
1122 typedef struct ARListElem
1123         {
1124         struct ARListElem *next;
1125         AuthRecord ar;          // Note: Must be last element of structure, to accomodate oversized AuthRecords
1126         } ARListElem;
1127
1128 struct CacheGroup_struct                                // Header object for a list of CacheRecords with the same name
1129         {
1130         CacheGroup     *next;                           // Next CacheGroup object in this hash table bucket
1131         mDNSu32         namehash;                       // Name-based (i.e. case insensitive) hash of name
1132         CacheRecord    *members;                        // List of CacheRecords with this same name
1133         CacheRecord   **rrcache_tail;           // Tail end of that list
1134         domainname     *name;                           // Common name for all CacheRecords in this list
1135         // Size to here is 20 bytes when compiling 32-bit; 40 bytes when compiling 64-bit
1136         mDNSu8          namestorage[InlineCacheGroupNameSize];
1137         };
1138
1139 struct CacheRecord_struct
1140         {
1141         CacheRecord    *next;                           // Next in list; first element of structure for efficiency reasons
1142         ResourceRecord  resrec;                         // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit
1143
1144         // Transient state for Cache Records
1145         CacheRecord    *NextInKAList;           // Link to the next element in the chain of known answers to send
1146         mDNSs32         TimeRcvd;                       // In platform time units
1147         mDNSs32         DelayDelivery;          // Set if we want to defer delivery of this answer to local clients
1148         mDNSs32         NextRequiredQuery;      // In platform time units
1149         mDNSs32         LastUsed;                       // In platform time units
1150         DNSQuestion    *CRActiveQuestion;       // Points to an active question referencing this answer
1151         mDNSu32         UnansweredQueries;      // Number of times we've issued a query for this record without getting an answer
1152         mDNSs32         LastUnansweredTime;     // In platform time units; last time we incremented UnansweredQueries
1153 #if ENABLE_MULTI_PACKET_QUERY_SNOOPING
1154         mDNSu32         MPUnansweredQ;          // Multi-packet query handling: Number of times we've seen a query for this record
1155         mDNSs32         MPLastUnansweredQT;     // Multi-packet query handling: Last time we incremented MPUnansweredQ
1156         mDNSu32         MPUnansweredKA;         // Multi-packet query handling: Number of times we've seen this record in a KA list
1157         mDNSBool        MPExpectingKA;          // Multi-packet query handling: Set when we increment MPUnansweredQ; allows one KA
1158 #endif
1159         CacheRecord    *NextInCFList;           // Set if this is in the list of records we just received with the cache flush bit set
1160         // Size to here is 76 bytes when compiling 32-bit; 104 bytes when compiling 64-bit
1161         RData_small     smallrdatastorage;      // Storage for small records is right here (4 bytes header + 68 bytes data = 72 bytes)
1162         };
1163
1164 // Storage sufficient to hold either a CacheGroup header or a CacheRecord
1165 // -- for best efficiency (to avoid wasted unused storage) they should be the same size
1166 typedef union CacheEntity_union CacheEntity;
1167 union CacheEntity_union { CacheEntity *next; CacheGroup cg; CacheRecord cr; };
1168
1169 typedef struct
1170         {
1171         CacheRecord r;
1172         mDNSu8 _extradata[MaximumRDSize-InlineCacheRDSize];             // Glue on the necessary number of extra bytes
1173         domainname namestorage;                                                                 // Needs to go *after* the extra rdata bytes
1174         } LargeCacheRecord;
1175
1176 typedef struct HostnameInfo
1177         {
1178         struct HostnameInfo *next;
1179         NATTraversalInfo natinfo;
1180         domainname fqdn;
1181         AuthRecord arv4;                          // registered IPv4 address record
1182         AuthRecord arv6;                          // registered IPv6 address record
1183         mDNSRecordCallback *StatusCallback;       // callback to deliver success or error code to client layer
1184         const void *StatusContext;                // Client Context
1185         } HostnameInfo;
1186
1187 enum
1188         {
1189         DNSServer_Untested = 0,
1190         DNSServer_Passed   = 1,
1191         DNSServer_Failed   = 2,
1192         DNSServer_Disabled = 3
1193         };
1194
1195 enum
1196         {
1197         DNSServer_FlagDelete = 1,
1198         DNSServer_FlagNew    = 2
1199         };
1200
1201 typedef struct DNSServer
1202         {
1203         struct DNSServer *next;
1204         mDNSInterfaceID interface;      // For specialized uses; we can have DNS servers reachable over specific interfaces
1205         mDNSAddr        addr;
1206         mDNSIPPort      port;
1207         mDNSOpaque16    testid;
1208         mDNSu32         flags;          // Set when we're planning to delete this from the list
1209         mDNSu32         teststate;      // Have we sent bug-detection query to this server?
1210         mDNSs32         lasttest;       // Time we sent last bug-detection query to this server
1211         domainname      domain;         // name->server matching for "split dns"
1212         mDNSs32                 penaltyTime; // amount of time this server is penalized                 
1213         } DNSServer;
1214
1215 typedef struct ExtraResourceRecord_struct ExtraResourceRecord;
1216 struct ExtraResourceRecord_struct
1217         {
1218         ExtraResourceRecord *next;
1219         mDNSu32 ClientID;  // Opaque ID field to be used by client to map an AddRecord call to a set of Extra records
1220         AuthRecord r;
1221         // Note: Add any additional fields *before* the AuthRecord in this structure, not at the end.
1222         // In some cases clients can allocate larger chunks of memory and set r->rdata->MaxRDLength to indicate
1223         // that this extra memory is available, which would result in any fields after the AuthRecord getting smashed
1224         };
1225
1226 // Note: Within an mDNSServiceCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
1227 typedef void mDNSServiceCallback(mDNS *const m, ServiceRecordSet *const sr, mStatus result);
1228
1229 // A ServiceRecordSet is basically a convenience structure to group together
1230 // the PTR/SRV/TXT records that make up a standard service registration
1231 // It contains its own ServiceCallback+ServiceContext to report aggregate results up to the next layer of software above
1232 // It also contains:
1233 //  * the "_services" PTR record for service enumeration
1234 //  * the optional target host name (for proxy registrations)
1235 //  * the optional list of SubType PTR records
1236 //  * the optional list of additional records attached to the service set (e.g. iChat pictures)
1237 //
1238 // ... and a bunch of stuff related to uDNS, some of which could be simplified or eliminated
1239
1240 struct ServiceRecordSet_struct
1241         {
1242         // These internal state fields are used internally by mDNSCore; the client layer needn't be concerned with them.
1243         // No fields need to be set up by the client prior to calling mDNS_RegisterService();
1244         // all required data is passed as parameters to that function.
1245
1246         // Begin uDNS info ****************
1247         // All of these fields should be eliminated
1248
1249         // Note: The current uDNS code keeps an explicit list of registered services, and handles them
1250         // differently to how individual records are treated (this is probably a mistake). What this means is
1251         // that ServiceRecordSets for uDNS are kept in a linked list, whereas ServiceRecordSets for mDNS exist
1252         // just as a convenient placeholder to group the component records together and are not kept on any list.
1253         ServiceRecordSet *uDNS_next;
1254         regState_t        state;
1255         mDNSBool          srs_uselease;                         // dynamic update contains (should contain) lease option
1256         mDNSBool          TestForSelfConflict;          // on name conflict, check if we're just seeing our own orphaned records
1257         mDNSBool          Private;                                      // If zone is private, DNS updates may have to be encrypted to prevent eavesdropping
1258         ZoneData         *srs_nta;
1259         mDNSOpaque16      id;
1260         domainname        zone;                                         // the zone that is updated
1261         mDNSAddr          SRSUpdateServer;                      // primary name server for the record's zone  !!!KRS not technically correct to cache longer than TTL
1262         mDNSIPPort        SRSUpdatePort;                        // port on which server accepts dynamic updates
1263         NATTraversalInfo  NATinfo;
1264         mDNSBool          ClientCallbackDeferred;       // invoke client callback on completion of pending operation(s)
1265         mStatus           DeferredStatus;                       // status to deliver when above flag is set
1266         mDNSBool          SRVUpdateDeferred;            // do we need to change target or port once current operation completes?
1267         mDNSBool          SRVChanged;                           // temporarily deregistered service because its SRV target or port changed
1268         struct tcpInfo_t *tcp;
1269
1270         // End uDNS info ****************
1271
1272         mDNSServiceCallback *ServiceCallback;
1273         void                *ServiceContext;
1274         mDNSBool             Conflict;  // Set if this record set was forcibly deregistered because of a conflict
1275
1276         ExtraResourceRecord *Extras;    // Optional list of extra AuthRecords attached to this service registration
1277         mDNSu32              NumSubTypes;
1278         AuthRecord          *SubTypes;
1279         AuthRecord           RR_ADV;    // e.g. _services._dns-sd._udp.local. PTR _printer._tcp.local.
1280         AuthRecord           RR_PTR;    // e.g. _printer._tcp.local.        PTR Name._printer._tcp.local.
1281         AuthRecord           RR_SRV;    // e.g. Name._printer._tcp.local.   SRV 0 0 port target
1282         AuthRecord           RR_TXT;    // e.g. Name._printer._tcp.local.   TXT PrintQueueName
1283         // Don't add any fields after AuthRecord RR_TXT.
1284         // This is where the implicit extra space goes if we allocate a ServiceRecordSet containing an oversized RR_TXT record
1285         };
1286
1287 // ***************************************************************************
1288 #if 0
1289 #pragma mark -
1290 #pragma mark - Question structures
1291 #endif
1292
1293 // We record the last eight instances of each duplicate query
1294 // This gives us v4/v6 on each of Ethernet/AirPort and Firewire, and two free slots "for future expansion"
1295 // If the host has more active interfaces that this it is not fatal -- duplicate question suppression will degrade gracefully.
1296 // Since we will still remember the last eight, the busiest interfaces will still get the effective duplicate question suppression.
1297 #define DupSuppressInfoSize 8
1298
1299 typedef struct
1300         {
1301         mDNSs32               Time;
1302         mDNSInterfaceID       InterfaceID;
1303         mDNSs32               Type;                             // v4 or v6?
1304         } DupSuppressInfo;
1305
1306 typedef enum
1307         {
1308         LLQ_InitialRequest    = 1,
1309         LLQ_SecondaryRequest  = 2,
1310         LLQ_Established       = 3,
1311         LLQ_Poll              = 4
1312         } LLQ_State;
1313
1314 // LLQ constants
1315 #define kLLQ_Vers      1
1316 #define kLLQ_DefLease  7200 // 2 hours
1317 #define kLLQ_MAX_TRIES 3    // retry an operation 3 times max
1318 #define kLLQ_INIT_RESEND 2 // resend an un-ack'd packet after 2 seconds, then double for each additional
1319 // LLQ Operation Codes
1320 #define kLLQOp_Setup     1
1321 #define kLLQOp_Refresh   2
1322 #define kLLQOp_Event     3
1323
1324 // LLQ Errror Codes
1325 enum
1326         {
1327         LLQErr_NoError    = 0,
1328         LLQErr_ServFull   = 1,
1329         LLQErr_Static     = 2,
1330         LLQErr_FormErr    = 3,
1331         LLQErr_NoSuchLLQ  = 4,
1332         LLQErr_BadVers    = 5,
1333         LLQErr_UnknownErr = 6
1334         };
1335
1336 enum { NoAnswer_Normal = 0, NoAnswer_Suspended = 1, NoAnswer_Fail = 2 };
1337
1338 #define HMAC_LEN    64
1339 #define HMAC_IPAD   0x36
1340 #define HMAC_OPAD   0x5c
1341 #define MD5_LEN     16
1342
1343 #define AutoTunnelUnregistered(X) (                                              \
1344         (X)->AutoTunnelHostRecord.resrec.RecordType == kDNSRecordTypeUnregistered && \
1345         (X)->AutoTunnelDeviceInfo.resrec.RecordType == kDNSRecordTypeUnregistered && \
1346         (X)->AutoTunnelService.   resrec.RecordType == kDNSRecordTypeUnregistered    )
1347
1348 // Internal data structure to maintain authentication information
1349 typedef struct DomainAuthInfo
1350         {
1351         struct DomainAuthInfo *next;
1352         mDNSs32          deltime;                               // If we're planning to delete this DomainAuthInfo, the time we want it deleted
1353         mDNSBool         AutoTunnel;
1354         AuthRecord       AutoTunnelHostRecord;  // User-visible hostname; used as SRV target for AutoTunnel services
1355         AuthRecord       AutoTunnelTarget;              // Opaque hostname of tunnel endpoint; used as SRV target for AutoTunnelService record
1356         AuthRecord       AutoTunnelDeviceInfo;  // Device info of tunnel endpoint
1357         AuthRecord       AutoTunnelService;             // Service record (possibly NAT-Mapped) of IKE daemon implementing tunnel endpoint
1358         NATTraversalInfo AutoTunnelNAT;
1359         domainname       domain;
1360         domainname       keyname;
1361         char             b64keydata[32];
1362         mDNSu8           keydata_ipad[HMAC_LEN];        // padded key for inner hash rounds
1363         mDNSu8           keydata_opad[HMAC_LEN];        // padded key for outer hash rounds
1364         } DomainAuthInfo;
1365
1366 // Note: Within an mDNSQuestionCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
1367 typedef enum { QC_rmv = 0, QC_add = 1, QC_addnocache = 2 } QC_result;
1368 typedef void mDNSQuestionCallback(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord);
1369 struct DNSQuestion_struct
1370         {
1371         // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
1372         DNSQuestion          *next;
1373         mDNSu32               qnamehash;
1374         mDNSs32               DelayAnswering;   // Set if we want to defer answering this question until the cache settles
1375         mDNSs32               LastQTime;                // Last scheduled transmission of this Q on *all* applicable interfaces
1376         mDNSs32               ThisQInterval;    // LastQTime + ThisQInterval is the next scheduled transmission of this Q
1377                                                                                         // ThisQInterval > 0 for an active question;
1378                                                                                         // ThisQInterval = 0 for a suspended question that's still in the list
1379                                                                                         // ThisQInterval = -1 for a cancelled question (should not still be in list)
1380         mDNSs32               ExpectUnicastResp;// Set when we send a query with the kDNSQClass_UnicastResponse bit set
1381         mDNSs32               LastAnswerPktNum; // The sequence number of the last response packet containing an answer to this Q
1382         mDNSu32               RecentAnswerPkts; // Number of answers since the last time we sent this query
1383         mDNSu32               CurrentAnswers;   // Number of records currently in the cache that answer this question
1384         mDNSu32               LargeAnswers;             // Number of answers with rdata > 1024 bytes
1385         mDNSu32               UniqueAnswers;    // Number of answers received with kDNSClass_UniqueRRSet bit set
1386         mDNSInterfaceID       FlappingInterface1;// Set when an interface goes away, to flag if remove events are delivered for this Q
1387         mDNSInterfaceID       FlappingInterface2;// Set when an interface goes away, to flag if remove events are delivered for this Q
1388         DomainAuthInfo       *AuthInfo;                 // Non-NULL if query is currently being done using Private DNS
1389         DNSQuestion          *DuplicateOf;
1390         DNSQuestion          *NextInDQList;
1391         DupSuppressInfo       DupSuppress[DupSuppressInfoSize];
1392         mDNSInterfaceID       SendQNow;                 // The interface this query is being sent on right now
1393         mDNSBool              SendOnAll;                // Set if we're sending this question on all active interfaces
1394         mDNSu32               RequestUnicast;   // Non-zero if we want to send query with kDNSQClass_UnicastResponse bit set
1395         mDNSs32               LastQTxTime;              // Last time this Q was sent on one (but not necessarily all) interfaces
1396         mDNSu32               CNAMEReferrals;   // Count of how many CNAME redirections we've done
1397
1398         // Wide Area fields. These are used internally by the uDNS core
1399         UDPSocket            *LocalSocket;
1400         DNSServer            *qDNSServer;               // Caching server for this query (in the absence of an SRV saying otherwise)
1401         mDNSu8                unansweredQueries;// The number of unanswered queries to this server
1402
1403         ZoneData             *nta;                              // Used for getting zone data for private or LLQ query
1404         mDNSAddr              servAddr;                 // Address and port learned from _dns-llq, _dns-llq-tls or _dns-query-tls SRV query
1405         mDNSIPPort            servPort;
1406         struct tcpInfo_t *tcp;
1407         mDNSu8                NoAnswer;                 // Set if we want to suppress answers until tunnel setup has completed
1408
1409         // LLQ-specific fields. These fields are only meaningful when LongLived flag is set
1410         LLQ_State             state;
1411         mDNSu32               ReqLease;                 // seconds (relative)
1412         mDNSs32               expire;                   // ticks (absolute)
1413         mDNSs16               ntries;
1414         mDNSOpaque64          id;
1415
1416         // Client API fields: The client must set up these fields *before* calling mDNS_StartQuery()
1417         mDNSInterfaceID       InterfaceID;              // Non-zero if you want to issue queries only on a single specific IP interface
1418         mDNSAddr              Target;                   // Non-zero if you want to direct queries to a specific unicast target address
1419         mDNSIPPort            TargetPort;               // Must be set if Target is set
1420         mDNSOpaque16          TargetQID;                // Must be set if Target is set
1421         domainname            qname;
1422         mDNSu16               qtype;
1423         mDNSu16               qclass;
1424         mDNSBool              LongLived;        // Set by client for calls to mDNS_StartQuery to indicate LLQs to unicast layer.
1425         mDNSBool              ExpectUnique;             // Set by client if it's expecting unique RR(s) for this question, not shared RRs
1426         mDNSBool              ForceMCast;               // Set by client to force mDNS query, even for apparently uDNS names
1427         mDNSBool              ReturnIntermed;   // Set by client to request callbacks for intermediate CNAME/NXDOMAIN results
1428         mDNSQuestionCallback *QuestionCallback;
1429         void                 *QuestionContext;
1430         };
1431
1432 typedef struct
1433         {
1434         // Client API fields: The client must set up name and InterfaceID *before* calling mDNS_StartResolveService()
1435         // When the callback is invoked, ip, port, TXTlen and TXTinfo will have been filled in with the results learned from the network.
1436         domainname      name;
1437         mDNSInterfaceID InterfaceID;            // ID of the interface the response was received on
1438         mDNSAddr        ip;                                     // Remote (destination) IP address where this service can be accessed
1439         mDNSIPPort      port;                           // Port where this service can be accessed
1440         mDNSu16         TXTlen;
1441         mDNSu8          TXTinfo[2048];          // Additional demultiplexing information (e.g. LPR queue name)
1442         } ServiceInfo;
1443
1444 // Note: Within an mDNSServiceInfoQueryCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
1445 typedef struct ServiceInfoQuery_struct ServiceInfoQuery;
1446 typedef void mDNSServiceInfoQueryCallback(mDNS *const m, ServiceInfoQuery *query);
1447 struct ServiceInfoQuery_struct
1448         {
1449         // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
1450         // No fields need to be set up by the client prior to calling mDNS_StartResolveService();
1451         // all required data is passed as parameters to that function.
1452         // The ServiceInfoQuery structure memory is working storage for mDNSCore to discover the requested information
1453         // and place it in the ServiceInfo structure. After the client has called mDNS_StopResolveService(), it may
1454         // dispose of the ServiceInfoQuery structure while retaining the results in the ServiceInfo structure.
1455         DNSQuestion                   qSRV;
1456         DNSQuestion                   qTXT;
1457         DNSQuestion                   qAv4;
1458         DNSQuestion                   qAv6;
1459         mDNSu8                        GotSRV;
1460         mDNSu8                        GotTXT;
1461         mDNSu8                        GotADD;
1462         mDNSu32                       Answers;
1463         ServiceInfo                  *info;
1464         mDNSServiceInfoQueryCallback *ServiceInfoQueryCallback;
1465         void                         *ServiceInfoQueryContext;
1466         };
1467
1468 typedef enum { ZoneServiceUpdate, ZoneServiceQuery, ZoneServiceLLQ } ZoneService;
1469
1470 typedef void ZoneDataCallback(mDNS *const m, mStatus err, const ZoneData *result);
1471
1472 struct ZoneData_struct
1473         {
1474         domainname       ChildName;                     // Name for which we're trying to find the responsible server
1475         ZoneService      ZoneService;           // Which service we're seeking for this zone (update, query, or LLQ)
1476         domainname       *CurrentSOA;           // Points to somewhere within ChildName
1477         domainname       ZoneName;                      // Discovered result: Left-hand-side of SOA record
1478         mDNSu16          ZoneClass;                     // Discovered result: DNS Class from SOA record
1479         domainname       Host;                          // Discovered result: Target host from SRV record
1480         mDNSIPPort       Port;                          // Discovered result: Update port, query port, or LLQ port from SRV record
1481         mDNSAddr         Addr;                          // Discovered result: Address of Target host from SRV record
1482         mDNSBool         ZonePrivate;           // Discovered result: Does zone require encrypted queries?
1483         ZoneDataCallback *ZoneDataCallback;     // Caller-specified function to be called upon completion
1484         void             *ZoneDataContext;
1485         DNSQuestion      question;                      // Storage for any active question
1486         };
1487
1488 extern ZoneData *StartGetZoneData(mDNS *const m, const domainname *const name, const ZoneService target, ZoneDataCallback callback, void *callbackInfo);
1489 extern void CancelGetZoneData(mDNS *const m, ZoneData *nta);
1490
1491 typedef struct DNameListElem
1492         {
1493         struct DNameListElem *next;
1494         mDNSu32 uid;
1495         domainname name;
1496         } DNameListElem;
1497
1498 #if APPLE_OSX_mDNSResponder
1499 typedef struct ClientTunnel
1500         {
1501         struct ClientTunnel *next;
1502         domainname dstname;
1503         mDNSBool   MarkedForDeletion;
1504         mDNSv6Addr loc_inner;
1505         mDNSv4Addr loc_outer;
1506         mDNSv6Addr rmt_inner;
1507         mDNSv4Addr rmt_outer;
1508         mDNSIPPort rmt_outer_port;
1509         DNSQuestion q;
1510         } ClientTunnel;
1511 #endif
1512
1513 // ***************************************************************************
1514 #if 0
1515 #pragma mark -
1516 #pragma mark - NetworkInterfaceInfo_struct
1517 #endif
1518
1519 typedef struct NetworkInterfaceInfo_struct NetworkInterfaceInfo;
1520
1521 // A NetworkInterfaceInfo_struct serves two purposes:
1522 // 1. It holds the address, PTR and HINFO records to advertise a given IP address on a given physical interface
1523 // 2. It tells mDNSCore which physical interfaces are available; each physical interface has its own unique InterfaceID.
1524 //    Since there may be multiple IP addresses on a single physical interface,
1525 //    there may be multiple NetworkInterfaceInfo_structs with the same InterfaceID.
1526 //    In this case, to avoid sending the same packet n times, when there's more than one
1527 //    struct with the same InterfaceID, mDNSCore picks one member of the set to be the
1528 //    active representative of the set; all others have the 'InterfaceActive' flag unset.
1529
1530 struct NetworkInterfaceInfo_struct
1531         {
1532         // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
1533         NetworkInterfaceInfo *next;
1534
1535         mDNSu8          InterfaceActive;        // Set if interface is sending & receiving packets (see comment above)
1536         mDNSu8          IPv4Available;          // If InterfaceActive, set if v4 available on this InterfaceID
1537         mDNSu8          IPv6Available;          // If InterfaceActive, set if v6 available on this InterfaceID
1538
1539         DNSQuestion     NetWakeBrowse;
1540         DNSQuestion     NetWakeResolve[3];      // For fault-tolerance, we try up to three Sleep Proxies
1541         mDNSAddr        SPSAddr[3];
1542         mDNSIPPort      SPSPort[3];
1543         mDNSs32         NextSPSAttempt;         // -1 if we're not currently attempting to register with any Sleep Proxy
1544         mDNSs32         NextSPSAttemptTime;
1545
1546         // Standard AuthRecords that every Responder host should have (one per active IP address)
1547         AuthRecord RR_A;                                        // 'A' or 'AAAA' (address) record for our ".local" name
1548         AuthRecord RR_PTR;                                      // PTR (reverse lookup) record
1549         AuthRecord RR_HINFO;
1550
1551         // Client API fields: The client must set up these fields *before* calling mDNS_RegisterInterface()
1552         mDNSInterfaceID InterfaceID;            // Identifies physical interface; MUST NOT be 0, -1, or -2
1553         mDNSAddr        ip;                                     // The IPv4 or IPv6 address to advertise
1554         mDNSAddr        mask;
1555         mDNSEthAddr     MAC;
1556         char            ifname[64];                     // Windows uses a GUID string for the interface name, which doesn't fit in 16 bytes
1557         mDNSu8          Advertise;                      // False if you are only searching on this interface
1558         mDNSu8          McastTxRx;                      // Send/Receive multicast on this { InterfaceID, address family } ?
1559         mDNSu8          NetWake;                        // Set if Wake-On-Magic-Packet is enabled on this interface
1560         };
1561
1562 typedef struct SearchListElem
1563         {
1564         struct SearchListElem *next;
1565         domainname domain;
1566         int flag;               // -1 means delete, 0 means unchanged, +1 means newly added
1567         DNSQuestion BrowseQ;
1568         DNSQuestion DefBrowseQ;
1569         DNSQuestion AutomaticBrowseQ;
1570         DNSQuestion RegisterQ;
1571         DNSQuestion DefRegisterQ;
1572         ARListElem *AuthRecs;
1573         } SearchListElem;
1574
1575 // For domain enumeration and automatic browsing
1576 // This is the user's DNS search list.
1577 // In each of these domains we search for our special pointer records (lb._dns-sd._udp.<domain>, etc.)
1578 // to discover recommended domains for domain enumeration (browse, default browse, registration,
1579 // default registration) and possibly one or more recommended automatic browsing domains.
1580 extern SearchListElem *SearchList;              // This really ought to be part of mDNS_struct -- SC
1581
1582 // ***************************************************************************
1583 #if 0
1584 #pragma mark -
1585 #pragma mark - Main mDNS object, used to hold all the mDNS state
1586 #endif
1587
1588 typedef void mDNSCallback(mDNS *const m, mStatus result);
1589
1590 #define CACHE_HASH_SLOTS 499
1591
1592 enum
1593         {
1594         mDNS_KnownBug_PhantomInterfaces = 1,
1595         mDNS_KnownBug_LossySyslog       = 2             // <rdar://problem/6561888>
1596         };
1597
1598 enum
1599         {
1600         SleepState_Awake = 0,
1601         SleepState_Transferring = 1,
1602         SleepState_Sleeping = 2
1603         };
1604
1605 struct mDNS_struct
1606         {
1607         // Internal state fields. These hold the main internal state of mDNSCore;
1608         // the client layer needn't be concerned with them.
1609         // No fields need to be set up by the client prior to calling mDNS_Init();
1610         // all required data is passed as parameters to that function.
1611
1612         mDNS_PlatformSupport *p;                        // Pointer to platform-specific data of indeterminite size
1613         mDNSu32  KnownBugs;
1614         mDNSBool CanReceiveUnicastOn5353;
1615         mDNSBool AdvertiseLocalAddresses;
1616         mDNSBool DivertMulticastAdvertisements; // from interfaces that do not advertise local addresses to local-only
1617         mStatus mDNSPlatformStatus;
1618         mDNSIPPort UnicastPort4;
1619         mDNSIPPort UnicastPort6;
1620         mDNSEthAddr PrimaryMAC;                         // Used as unique host ID
1621         mDNSCallback *MainCallback;
1622         void         *MainContext;
1623
1624         // For debugging: To catch and report locking failures
1625         mDNSu32 mDNS_busy;                                      // Incremented between mDNS_Lock/mDNS_Unlock section
1626         mDNSu32 mDNS_reentrancy;                        // Incremented when calling a client callback
1627         mDNSu8  lock_rrcache;                           // For debugging: Set at times when these lists may not be modified
1628         mDNSu8  lock_Questions;
1629         mDNSu8  lock_Records;
1630 #ifndef MaxMsg
1631         #define MaxMsg 160
1632 #endif
1633         char MsgBuffer[MaxMsg];                         // Temp storage used while building error log messages
1634
1635         // Task Scheduling variables
1636         mDNSs32  timenow_adjust;                        // Correction applied if we ever discover time went backwards
1637         mDNSs32  timenow;                                       // The time that this particular activation of the mDNS code started
1638         mDNSs32  timenow_last;                          // The time the last time we ran
1639         mDNSs32  NextScheduledEvent;            // Derived from values below
1640         mDNSs32  ShutdownTime;                          // Set when we're shutting down; allows us to skip some unnecessary steps
1641         mDNSs32  SuppressSending;                       // Don't send *any* packets during this time
1642         mDNSs32  NextCacheCheck;                        // Next time to refresh cache record before it expires
1643         mDNSs32  NextScheduledQuery;            // Next time to send query in its exponential backoff sequence
1644         mDNSs32  NextScheduledProbe;            // Next time to probe for new authoritative record
1645         mDNSs32  NextScheduledResponse;         // Next time to send authoritative record(s) in responses
1646         mDNSs32  NextScheduledNATOp;            // Next time to send NAT-traversal packets
1647         mDNSs32  NextScheduledSPS;                      // Next time to purge expiring Sleep Proxy records
1648         mDNSs32  RandomQueryDelay;                      // For de-synchronization of query packets on the wire
1649         mDNSu32  RandomReconfirmDelay;          // For de-synchronization of reconfirmation queries on the wire
1650         mDNSs32  PktNum;                                        // Unique sequence number assigned to each received packet
1651         mDNSu8   SleepState;                            // Set if we're sleeping
1652         mDNSu8   SleepSeqNum;                           // "Epoch number" of our current period of wakefulness
1653         mDNSu8   SystemWakeOnLANEnabled;        // Set if we want to register with a Sleep Proxy before going to sleep
1654         mDNSu8   SentSleepProxyRegistration;// Set if we registered (or tried to register) with a Sleep Proxy
1655         mDNSs32  AnnounceOwner;                         // After waking from sleep, include OWNER option in packets until this time
1656         mDNSs32  DelaySleep;                            // To inhibit re-sleeping too quickly right after wake
1657         mDNSs32  SleepLimit;                            // Time window to allow deregistrations, etc.,
1658                                                                                 // during which underying platform layer should inhibit system sleep
1659         mDNSs32  NextScheduledSPRetry;          // Time next sleep proxy registration action is required.
1660                                                                                 // Only valid if SleepLimit is nonzero and DelaySleep is zero.
1661
1662         // These fields only required for mDNS Searcher...
1663         DNSQuestion *Questions;                         // List of all registered questions, active and inactive
1664         DNSQuestion *NewQuestions;                      // Fresh questions not yet answered from cache
1665         DNSQuestion *CurrentQuestion;           // Next question about to be examined in AnswerLocalQuestions()
1666         DNSQuestion *LocalOnlyQuestions;        // Questions with InterfaceID set to mDNSInterface_LocalOnly
1667         DNSQuestion *NewLocalOnlyQuestions;     // Fresh local-only questions not yet answered
1668         mDNSu32 rrcache_size;                           // Total number of available cache entries
1669         mDNSu32 rrcache_totalused;                      // Number of cache entries currently occupied
1670         mDNSu32 rrcache_active;                         // Number of cache entries currently occupied by records that answer active questions
1671         mDNSu32 rrcache_report;
1672         CacheEntity *rrcache_free;
1673         CacheGroup *rrcache_hash[CACHE_HASH_SLOTS];
1674
1675         // Fields below only required for mDNS Responder...
1676         domainlabel nicelabel;                          // Rich text label encoded using canonically precomposed UTF-8
1677         domainlabel hostlabel;                          // Conforms to RFC 1034 "letter-digit-hyphen" ARPANET host name rules
1678         domainname  MulticastHostname;          // Fully Qualified "dot-local" Host Name, e.g. "Foo.local."
1679         UTF8str255  HIHardware;
1680         UTF8str255  HISoftware;
1681         AuthRecord  DeviceInfo;
1682         AuthRecord *ResourceRecords;
1683         AuthRecord *DuplicateRecords;           // Records currently 'on hold' because they are duplicates of existing records
1684         AuthRecord *NewLocalRecords;            // Fresh local-only records not yet delivered to local-only questions
1685         AuthRecord *CurrentRecord;                      // Next AuthRecord about to be examined
1686         NetworkInterfaceInfo *HostInterfaces;
1687         mDNSs32 ProbeFailTime;
1688         mDNSu32 NumFailedProbes;
1689         mDNSs32 SuppressProbes;
1690
1691         // Unicast-specific data
1692         mDNSs32           NextuDNSEvent;                // uDNS next event
1693         mDNSs32           NextSRVUpdate;        // Time to perform delayed update
1694         mDNSs32 SuppressStdPort53Queries;       // Wait before allowing the next standard unicast query to the user's configured DNS server
1695
1696         ServiceRecordSet *ServiceRegistrations;
1697         DNSServer        *DNSServers;           // list of DNS servers
1698
1699         mDNSAddr          Router;
1700         mDNSAddr          AdvertisedV4;         // IPv4 address pointed to by hostname
1701         mDNSAddr          AdvertisedV6;         // IPv6 address pointed to by hostname
1702
1703         DomainAuthInfo   *AuthInfoList;         // list of domains requiring authentication for updates
1704
1705         DNSQuestion       ReverseMap;           // Reverse-map query to find static hostname for service target
1706         DNSQuestion       AutomaticBrowseDomainQ;
1707         domainname        StaticHostname;       // Current answer to reverse-map query
1708         domainname        FQDN;
1709         HostnameInfo     *Hostnames;            // List of registered hostnames + hostname metadata
1710         mDNSv6Addr        AutoTunnelHostAddr;   // IPv6 address advertised for AutoTunnel services on this machine
1711         mDNSBool          AutoTunnelHostAddrActive;
1712         domainlabel       AutoTunnelLabel;              // Used to construct hostname for *IPv4* address of tunnel endpoints
1713
1714         mDNSBool          RegisterSearchDomains;
1715
1716         // NAT-Traversal fields
1717         NATTraversalInfo  LLQNAT;                                       // Single shared NAT Traversal to receive inbound LLQ notifications
1718         NATTraversalInfo *NATTraversals;
1719         NATTraversalInfo *CurrentNATTraversal;
1720         mDNSs32           retryIntervalGetAddr;         // delta between time sent and retry
1721         mDNSs32           retryGetAddr;                         // absolute time when we retry
1722         mDNSv4Addr        ExternalAddress;
1723
1724         UDPSocket        *NATMcastRecvskt;                      // For receiving NAT-PMP AddrReply multicasts from router on port 5350
1725         mDNSu32           LastNATupseconds;                     // NAT engine uptime in seconds, from most recent NAT packet
1726         mDNSs32           LastNATReplyLocalTime;        // Local time in ticks when most recent NAT packet was received
1727         mDNSu16           LastNATMapResultCode;         // Most recent error code for mappings
1728
1729         tcpLNTInfo        tcpAddrInfo;                          // legacy NAT traversal TCP connection info for external address
1730         tcpLNTInfo        tcpDeviceInfo;                        // legacy NAT traversal TCP connection info for device info
1731         tcpLNTInfo       *tcpInfoUnmapList;                     // list of pending unmap requests
1732         mDNSInterfaceID   UPnPInterfaceID;
1733         UDPSocket        *SSDPSocket;               // For SSDP request/response
1734         mDNSBool          SSDPWANPPPConnection;     // whether we should send the SSDP query for WANIPConnection or WANPPPConnection
1735         mDNSIPPort        UPnPRouterPort;                       // port we send discovery messages to
1736         mDNSIPPort        UPnPSOAPPort;                         // port we send SOAP messages to
1737         mDNSu8           *UPnPRouterURL;                        // router's URL string
1738         mDNSBool          UPnPWANPPPConnection;     // whether we're using WANIPConnection or WANPPPConnection
1739         mDNSu8           *UPnPSOAPURL;                          // router's SOAP control URL string
1740         mDNSu8           *UPnPRouterAddressString;      // holds both the router's address and port
1741         mDNSu8           *UPnPSOAPAddressString;        // holds both address and port for SOAP messages
1742
1743         // Sleep Proxy Server fields
1744         mDNSu8            SPSType;                                      // 0 = off, 10-99 encodes desirability metric
1745         mDNSu8            SPSPortability;                       // 10-99
1746         mDNSu8            SPSMarginalPower;                     // 10-99
1747         mDNSu8            SPSTotalPower;                        // 10-99
1748         mDNSu8            SPSState;                                     // 0 = off, 1 = running, 2 = shutting down, 3 = suspended during sleep
1749         mDNSInterfaceID   SPSProxyListChanged;
1750         UDPSocket        *SPSSocket;
1751         ServiceRecordSet  SPSRecords;
1752         mDNSQuestionCallback *SPSBrowseCallback;    // So the platform layer can do something useful with SPS browse results
1753         int               ProxyRecords;                         // Total number of records we're holding as proxy
1754         #define           MAX_PROXY_RECORDS 10000       /* DOS protection: 400 machines at 25 records each */
1755
1756 #if APPLE_OSX_mDNSResponder
1757         ClientTunnel     *TunnelClients;
1758         uuid_t           asl_uuid;                                      // uuid for ASL logging
1759 #endif
1760
1761         // Fixed storage, to avoid creating large objects on the stack
1762         // The imsg is declared as a union with a pointer type to enforce CPU-appropriate alignment
1763         union { DNSMessage m; void *p; } imsg;  // Incoming message received from wire
1764         DNSMessage        omsg;                 // Outgoing message we're building
1765         LargeCacheRecord  rec;                  // Resource Record extracted from received message
1766         };
1767
1768 #define FORALL_CACHERECORDS(SLOT,CG,CR)                           \
1769         for ((SLOT) = 0; (SLOT) < CACHE_HASH_SLOTS; (SLOT)++)         \
1770                 for ((CG)=m->rrcache_hash[(SLOT)]; (CG); (CG)=(CG)->next) \
1771                         for ((CR) = (CG)->members; (CR); (CR)=(CR)->next)
1772
1773 // ***************************************************************************
1774 #if 0
1775 #pragma mark -
1776 #pragma mark - Useful Static Constants
1777 #endif
1778
1779 extern const mDNSIPPort      zeroIPPort;
1780 extern const mDNSv4Addr      zerov4Addr;
1781 extern const mDNSv6Addr      zerov6Addr;
1782 extern const mDNSEthAddr     zeroEthAddr;
1783 extern const mDNSv4Addr      onesIPv4Addr;
1784 extern const mDNSv6Addr      onesIPv6Addr;
1785 extern const mDNSEthAddr     onesEthAddr;
1786 extern const mDNSAddr        zeroAddr;
1787
1788 extern const OwnerOptData    zeroOwner;
1789
1790 extern const mDNSInterfaceID mDNSInterface_Any;                         // Zero
1791 extern const mDNSInterfaceID mDNSInterface_LocalOnly;           // Special value
1792 extern const mDNSInterfaceID mDNSInterface_Unicast;                     // Special value
1793
1794 extern const mDNSIPPort   DiscardPort;
1795 extern const mDNSIPPort   SSHPort;
1796 extern const mDNSIPPort   UnicastDNSPort;
1797 extern const mDNSIPPort   SSDPPort;
1798 extern const mDNSIPPort   IPSECPort;
1799 extern const mDNSIPPort   NSIPCPort;
1800 extern const mDNSIPPort   NATPMPAnnouncementPort;
1801 extern const mDNSIPPort   NATPMPPort;
1802 extern const mDNSIPPort   DNSEXTPort;
1803 extern const mDNSIPPort   MulticastDNSPort;
1804 extern const mDNSIPPort   LoopbackIPCPort;
1805 extern const mDNSIPPort   PrivateDNSPort;
1806
1807 extern const mDNSv4Addr   AllDNSAdminGroup;
1808 extern const mDNSv4Addr   AllSystemsMcast;
1809 extern const mDNSAddr     AllDNSLinkGroup_v4;
1810 extern const mDNSAddr     AllDNSLinkGroup_v6;
1811
1812 extern const mDNSOpaque16 zeroID;
1813 extern const mDNSOpaque16 onesID;
1814 extern const mDNSOpaque16 QueryFlags;
1815 extern const mDNSOpaque16 uQueryFlags;
1816 extern const mDNSOpaque16 ResponseFlags;
1817 extern const mDNSOpaque16 UpdateReqFlags;
1818 extern const mDNSOpaque16 UpdateRespFlags;
1819
1820 extern const mDNSOpaque64 zeroOpaque64;
1821
1822 extern mDNSBool StrictUnicastOrdering;
1823
1824 #define localdomain           (*(const domainname *)"\x5" "local")
1825 #define DeviceInfoName        (*(const domainname *)"\xC" "_device-info" "\x4" "_tcp")
1826 #define SleepProxyServiceType (*(const domainname *)"\xC" "_sleep-proxy" "\x4" "_udp")
1827
1828 // ***************************************************************************
1829 #if 0
1830 #pragma mark -
1831 #pragma mark - Inline functions
1832 #endif
1833
1834 #if (defined(_MSC_VER))
1835         #define mDNSinline static __inline
1836 #elif ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
1837         #define mDNSinline static inline
1838 #endif
1839
1840 // If we're not doing inline functions, then this header needs to have the extern declarations
1841 #if !defined(mDNSinline)
1842 extern mDNSs32      NonZeroTime(mDNSs32 t);
1843 extern mDNSu16      mDNSVal16(mDNSOpaque16 x);
1844 extern mDNSOpaque16 mDNSOpaque16fromIntVal(mDNSu16 v);
1845 #endif
1846
1847 // If we're compiling the particular C file that instantiates our inlines, then we
1848 // define "mDNSinline" (to empty string) so that we generate code in the following section
1849 #if (!defined(mDNSinline) && mDNS_InstantiateInlines)
1850 #define mDNSinline
1851 #endif
1852
1853 #ifdef mDNSinline
1854
1855 mDNSinline mDNSs32 NonZeroTime(mDNSs32 t) { if (t) return(t); else return(1); }
1856
1857 mDNSinline mDNSu16 mDNSVal16(mDNSOpaque16 x) { return((mDNSu16)((mDNSu16)x.b[0] <<  8 | (mDNSu16)x.b[1])); }
1858
1859 mDNSinline mDNSOpaque16 mDNSOpaque16fromIntVal(mDNSu16 v)
1860         {
1861         mDNSOpaque16 x;
1862         x.b[0] = (mDNSu8)(v >> 8);
1863         x.b[1] = (mDNSu8)(v & 0xFF);
1864         return(x);
1865         }
1866
1867 #endif
1868
1869 // ***************************************************************************
1870 #if 0
1871 #pragma mark -
1872 #pragma mark - Main Client Functions
1873 #endif
1874
1875 // Every client should call mDNS_Init, passing in storage for the mDNS object and the mDNS_PlatformSupport object.
1876 //
1877 // Clients that are only advertising services should use mDNS_Init_NoCache and mDNS_Init_ZeroCacheSize.
1878 // Clients that plan to perform queries (mDNS_StartQuery, mDNS_StartBrowse, mDNS_StartResolveService, etc.)
1879 // need to provide storage for the resource record cache, or the query calls will return 'mStatus_NoCache'.
1880 // The rrcachestorage parameter is the address of memory for the resource record cache, and
1881 // the rrcachesize parameter is the number of entries in the CacheRecord array passed in.
1882 // (i.e. the size of the cache memory needs to be sizeof(CacheRecord) * rrcachesize).
1883 // OS X 10.3 Panther uses an initial cache size of 64 entries, and then mDNSCore sends an
1884 // mStatus_GrowCache message if it needs more.
1885 //
1886 // Most clients should use mDNS_Init_AdvertiseLocalAddresses. This causes mDNSCore to automatically
1887 // create the correct address records for all the hosts interfaces. If you plan to advertise
1888 // services being offered by the local machine, this is almost always what you want.
1889 // There are two cases where you might use mDNS_Init_DontAdvertiseLocalAddresses:
1890 // 1. A client-only device, that browses for services but doesn't advertise any of its own.
1891 // 2. A proxy-registration service, that advertises services being offered by other machines, and takes
1892 //    the appropriate steps to manually create the correct address records for those other machines.
1893 // In principle, a proxy-like registration service could manually create address records for its own machine too,
1894 // but this would be pointless extra effort when using mDNS_Init_AdvertiseLocalAddresses does that for you.
1895 //
1896 // Note that a client-only device that wishes to prohibit multicast advertisements (e.g. from
1897 // higher-layer API calls) must also set DivertMulticastAdvertisements in the mDNS structure and
1898 // advertise local address(es) on a loopback interface.
1899 //
1900 // When mDNS has finished setting up the client's callback is called
1901 // A client can also spin and poll the mDNSPlatformStatus field to see when it changes from mStatus_Waiting to mStatus_NoError
1902 //
1903 // Call mDNS_StartExit to tidy up before exiting
1904 // Because exiting may be an asynchronous process (e.g. if unicast records need to be deregistered)
1905 // client layer may choose to wait until mDNS_ExitNow() returns true before calling mDNS_FinalExit().
1906 //
1907 // Call mDNS_Register with a completed AuthRecord object to register a resource record
1908 // If the resource record type is kDNSRecordTypeUnique (or kDNSknownunique) then if a conflicting resource record is discovered,
1909 // the resource record's mDNSRecordCallback will be called with error code mStatus_NameConflict. The callback should deregister
1910 // the record, and may then try registering the record again after picking a new name (e.g. by automatically appending a number).
1911 // Following deregistration, the RecordCallback will be called with result mStatus_MemFree to signal that it is safe to deallocate
1912 // the record's storage (memory must be freed asynchronously to allow for goodbye packets and dynamic update deregistration).
1913 //
1914 // Call mDNS_StartQuery to initiate a query. mDNS will proceed to issue Multicast DNS query packets, and any time a response
1915 // is received containing a record which matches the question, the DNSQuestion's mDNSAnswerCallback function will be called
1916 // Call mDNS_StopQuery when no more answers are required
1917 //
1918 // Care should be taken on multi-threaded or interrupt-driven environments.
1919 // The main mDNS routines call mDNSPlatformLock() on entry and mDNSPlatformUnlock() on exit;
1920 // each platform layer needs to implement these appropriately for its respective platform.
1921 // For example, if the support code on a particular platform implements timer callbacks at interrupt time, then
1922 // mDNSPlatformLock/Unlock need to disable interrupts or do similar concurrency control to ensure that the mDNS
1923 // code is not entered by an interrupt-time timer callback while in the middle of processing a client call.
1924
1925 extern mStatus mDNS_Init      (mDNS *const m, mDNS_PlatformSupport *const p,
1926                                                                 CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
1927                                                                 mDNSBool AdvertiseLocalAddresses,
1928                                                                 mDNSCallback *Callback, void *Context);
1929 // See notes above on use of NoCache/ZeroCacheSize
1930 #define mDNS_Init_NoCache                     mDNSNULL
1931 #define mDNS_Init_ZeroCacheSize               0
1932 // See notes above on use of Advertise/DontAdvertiseLocalAddresses
1933 #define mDNS_Init_AdvertiseLocalAddresses     mDNStrue
1934 #define mDNS_Init_DontAdvertiseLocalAddresses mDNSfalse
1935 #define mDNS_Init_NoInitCallback              mDNSNULL
1936 #define mDNS_Init_NoInitCallbackContext       mDNSNULL
1937
1938 extern void    mDNS_ConfigChanged(mDNS *const m);
1939 extern void    mDNS_GrowCache (mDNS *const m, CacheEntity *storage, mDNSu32 numrecords);
1940 extern void    mDNS_StartExit (mDNS *const m);
1941 extern void    mDNS_FinalExit (mDNS *const m);
1942 #define mDNS_Close(m) do { mDNS_StartExit(m); mDNS_FinalExit(m); } while(0)
1943 #define mDNS_ExitNow(m, now) ((now) - (m)->ShutdownTime >= 0 || (!(m)->ResourceRecords && !(m)->ServiceRegistrations))
1944
1945 extern mDNSs32 mDNS_Execute   (mDNS *const m);
1946
1947 extern mStatus mDNS_Register  (mDNS *const m, AuthRecord *const rr);
1948 extern mStatus mDNS_Update    (mDNS *const m, AuthRecord *const rr, mDNSu32 newttl,
1949                                                                 const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback);
1950 extern mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr);
1951
1952 extern mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question);
1953 extern mStatus mDNS_StopQuery (mDNS *const m, DNSQuestion *const question);
1954 extern mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question);
1955 extern mStatus mDNS_Reconfirm (mDNS *const m, CacheRecord *const cacherr);
1956 extern mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr);
1957 extern void    mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr);
1958 extern mDNSs32 mDNS_TimeNow(const mDNS *const m);
1959
1960 extern mStatus mDNS_StartNATOperation(mDNS *const m, NATTraversalInfo *traversal);
1961 extern mStatus mDNS_StopNATOperation(mDNS *const m, NATTraversalInfo *traversal);
1962 extern mStatus mDNS_StopNATOperation_internal(mDNS *m, NATTraversalInfo *traversal);
1963
1964 extern DomainAuthInfo *GetAuthInfoForName(mDNS *m, const domainname *const name);
1965
1966 // ***************************************************************************
1967 #if 0
1968 #pragma mark -
1969 #pragma mark - Platform support functions that are accessible to the client layer too
1970 #endif
1971
1972 extern mDNSs32  mDNSPlatformOneSecond;
1973
1974 // ***************************************************************************
1975 #if 0
1976 #pragma mark -
1977 #pragma mark - General utility and helper functions
1978 #endif
1979
1980 // mDNS_RegisterService is a single call to register the set of resource records associated with a given named service.
1981 //
1982 // mDNS_StartResolveService is single call which is equivalent to multiple calls to mDNS_StartQuery,
1983 // to find the IP address, port number, and demultiplexing information for a given named service.
1984 // As with mDNS_StartQuery, it executes asynchronously, and calls the ServiceInfoQueryCallback when the answer is
1985 // found. After the service is resolved, the client should call mDNS_StopResolveService to complete the transaction.
1986 // The client can also call mDNS_StopResolveService at any time to abort the transaction.
1987 //
1988 // mDNS_AddRecordToService adds an additional record to a Service Record Set.  This record may be deregistered
1989 // via mDNS_RemoveRecordFromService, or by deregistering the service.  mDNS_RemoveRecordFromService is passed a
1990 // callback to free the memory associated with the extra RR when it is safe to do so.  The ExtraResourceRecord
1991 // object can be found in the record's context pointer.
1992
1993 // mDNS_GetBrowseDomains is a special case of the mDNS_StartQuery call, where the resulting answers
1994 // are a list of PTR records indicating (in the rdata) domains that are recommended for browsing.
1995 // After getting the list of domains to browse, call mDNS_StopQuery to end the search.
1996 // mDNS_GetDefaultBrowseDomain returns the name of the domain that should be highlighted by default.
1997 //
1998 // mDNS_GetRegistrationDomains and mDNS_GetDefaultRegistrationDomain are the equivalent calls to get the list
1999 // of one or more domains that should be offered to the user as choices for where they may register their service,
2000 // and the default domain in which to register in the case where the user has made no selection.
2001
2002 extern void    mDNS_SetupResourceRecord(AuthRecord *rr, RData *RDataStorage, mDNSInterfaceID InterfaceID,
2003                mDNSu16 rrtype, mDNSu32 ttl, mDNSu8 RecordType, mDNSRecordCallback Callback, void *Context);
2004
2005 extern mStatus mDNS_RegisterService  (mDNS *const m, ServiceRecordSet *sr,
2006                const domainlabel *const name, const domainname *const type, const domainname *const domain,
2007                const domainname *const host, mDNSIPPort port, const mDNSu8 txtinfo[], mDNSu16 txtlen,
2008                AuthRecord *SubTypes, mDNSu32 NumSubTypes,
2009                const mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context);
2010 extern mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl);
2011 extern mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, mDNSRecordCallback MemFreeCallback, void *Context);
2012 extern mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname);
2013 extern mStatus mDNS_DeregisterService(mDNS *const m, ServiceRecordSet *sr);
2014
2015 extern mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr,
2016                const domainlabel *const name, const domainname *const type, const domainname *const domain,
2017                const domainname *const host,
2018                const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context);
2019 #define        mDNS_DeregisterNoSuchService mDNS_Deregister
2020
2021 extern void mDNS_SetupQuestion(DNSQuestion *const q, const mDNSInterfaceID InterfaceID, const domainname *const name,
2022                const mDNSu16 qtype, mDNSQuestionCallback *const callback, void *const context);
2023
2024 extern mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question,
2025                const domainname *const srv, const domainname *const domain,
2026                const mDNSInterfaceID InterfaceID, mDNSBool ForceMCast, mDNSQuestionCallback *Callback, void *Context);
2027 #define        mDNS_StopBrowse mDNS_StopQuery
2028
2029 extern mStatus mDNS_StartResolveService(mDNS *const m, ServiceInfoQuery *query, ServiceInfo *info, mDNSServiceInfoQueryCallback *Callback, void *Context);
2030 extern void    mDNS_StopResolveService (mDNS *const m, ServiceInfoQuery *query);
2031
2032 typedef enum
2033         {
2034         mDNS_DomainTypeBrowse              = 0,
2035         mDNS_DomainTypeBrowseDefault       = 1,
2036         mDNS_DomainTypeBrowseAutomatic     = 2,
2037         mDNS_DomainTypeRegistration        = 3,
2038         mDNS_DomainTypeRegistrationDefault = 4,
2039
2040         mDNS_DomainTypeMax = 4
2041         } mDNS_DomainType;
2042
2043 extern const char *const mDNS_DomainTypeNames[];
2044
2045 extern mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom,
2046                                                                 const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context);
2047 #define        mDNS_StopGetDomains mDNS_StopQuery
2048 extern mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr, mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname);
2049 #define        mDNS_StopAdvertiseDomains mDNS_Deregister
2050
2051 extern mDNSOpaque16 mDNS_NewMessageID(mDNS *const m);
2052                 
2053 extern DNSServer *GetServerForName(mDNS *m, const domainname *name, DNSServer *current);
2054
2055 // ***************************************************************************
2056 #if 0
2057 #pragma mark -
2058 #pragma mark - DNS name utility functions
2059 #endif
2060
2061 // In order to expose the full capabilities of the DNS protocol (which allows any arbitrary eight-bit values
2062 // in domain name labels, including unlikely characters like ascii nulls and even dots) all the mDNS APIs
2063 // work with DNS's native length-prefixed strings. For convenience in C, the following utility functions
2064 // are provided for converting between C's null-terminated strings and DNS's length-prefixed strings.
2065
2066 // Assignment
2067 // A simple C structure assignment of a domainname can cause a protection fault by accessing unmapped memory,
2068 // because that object is defined to be 256 bytes long, but not all domainname objects are truly the full size.
2069 // This macro uses mDNSPlatformMemCopy() to make sure it only touches the actual bytes that are valid.
2070 #define AssignDomainName(DST, SRC) do { mDNSu16 len__ = DomainNameLength((SRC)); \
2071         if (len__ <= MAX_DOMAIN_NAME) mDNSPlatformMemCopy((DST)->c, (SRC)->c, len__); else (DST)->c[0] = 0; } while(0)
2072
2073 // Comparison functions
2074 #define SameDomainLabelCS(A,B) ((A)[0] == (B)[0] && mDNSPlatformMemSame((A)+1, (B)+1, (A)[0]))
2075 extern mDNSBool SameDomainLabel(const mDNSu8 *a, const mDNSu8 *b);
2076 extern mDNSBool SameDomainName(const domainname *const d1, const domainname *const d2);
2077 extern mDNSBool SameDomainNameCS(const domainname *const d1, const domainname *const d2);
2078 extern mDNSBool IsLocalDomain(const domainname *d);     // returns true for domains that by default should be looked up using link-local multicast
2079
2080 #define StripFirstLabel(X) ((const domainname *)&(X)->c[(X)->c[0] ? 1 + (X)->c[0] : 0])
2081
2082 #define FirstLabel(X)  ((const domainlabel *)(X))
2083 #define SecondLabel(X) ((const domainlabel *)StripFirstLabel(X))
2084 #define ThirdLabel(X)  ((const domainlabel *)StripFirstLabel(StripFirstLabel(X)))
2085
2086 extern const mDNSu8 *LastLabel(const domainname *d);
2087
2088 // Get total length of domain name, in native DNS format, including terminal root label
2089 //   (e.g. length of "com." is 5 (length byte, three data bytes, final zero)
2090 extern mDNSu16  DomainNameLengthLimit(const domainname *const name, const mDNSu8 *limit);
2091 #define DomainNameLength(name) DomainNameLengthLimit((name), (name)->c + MAX_DOMAIN_NAME)
2092
2093 // Append functions to append one or more labels to an existing native format domain name:
2094 //   AppendLiteralLabelString adds a single label from a literal C string, with no escape character interpretation.
2095 //   AppendDNSNameString      adds zero or more labels from a C string using conventional DNS dots-and-escaping interpretation
2096 //   AppendDomainLabel        adds a single label from a native format domainlabel
2097 //   AppendDomainName         adds zero or more labels from a native format domainname
2098 extern mDNSu8  *AppendLiteralLabelString(domainname *const name, const char *cstr);
2099 extern mDNSu8  *AppendDNSNameString     (domainname *const name, const char *cstr);
2100 extern mDNSu8  *AppendDomainLabel       (domainname *const name, const domainlabel *const label);
2101 extern mDNSu8  *AppendDomainName        (domainname *const name, const domainname *const append);
2102
2103 // Convert from null-terminated string to native DNS format:
2104 //   The DomainLabel form makes a single label from a literal C string, with no escape character interpretation.
2105 //   The DomainName form makes native format domain name from a C string using conventional DNS interpretation:
2106 //     dots separate labels, and within each label, '\.' represents a literal dot, '\\' represents a literal
2107 //     backslash and backslash with three decimal digits (e.g. \000) represents an arbitrary byte value.
2108 extern mDNSBool MakeDomainLabelFromLiteralString(domainlabel *const label, const char *cstr);
2109 extern mDNSu8  *MakeDomainNameFromDNSNameString (domainname  *const name,  const char *cstr);
2110
2111 // Convert native format domainlabel or domainname back to C string format
2112 // IMPORTANT:
2113 // When using ConvertDomainLabelToCString, the target buffer must be MAX_ESCAPED_DOMAIN_LABEL (254) bytes long
2114 // to guarantee there will be no buffer overrun. It is only safe to use a buffer shorter than this in rare cases
2115 // where the label is known to be constrained somehow (for example, if the label is known to be either "_tcp" or "_udp").
2116 // Similarly, when using ConvertDomainNameToCString, the target buffer must be MAX_ESCAPED_DOMAIN_NAME (1009) bytes long.
2117 // See definitions of MAX_ESCAPED_DOMAIN_LABEL and MAX_ESCAPED_DOMAIN_NAME for more detailed explanation.
2118 extern char    *ConvertDomainLabelToCString_withescape(const domainlabel *const name, char *cstr, char esc);
2119 #define         ConvertDomainLabelToCString_unescaped(D,C) ConvertDomainLabelToCString_withescape((D), (C), 0)
2120 #define         ConvertDomainLabelToCString(D,C)           ConvertDomainLabelToCString_withescape((D), (C), '\\')
2121 extern char    *ConvertDomainNameToCString_withescape(const domainname *const name, char *cstr, char esc);
2122 #define         ConvertDomainNameToCString_unescaped(D,C) ConvertDomainNameToCString_withescape((D), (C), 0)
2123 #define         ConvertDomainNameToCString(D,C)           ConvertDomainNameToCString_withescape((D), (C), '\\')
2124
2125 extern void     ConvertUTF8PstringToRFC1034HostLabel(const mDNSu8 UTF8Name[], domainlabel *const hostlabel);
2126
2127 extern mDNSu8  *ConstructServiceName(domainname *const fqdn, const domainlabel *name, const domainname *type, const domainname *const domain);
2128 extern mDNSBool DeconstructServiceName(const domainname *const fqdn, domainlabel *const name, domainname *const type, domainname *const domain);
2129
2130 // Note: Some old functions have been replaced by more sensibly-named versions.
2131 // You can uncomment the hash-defines below if you don't want to have to change your source code right away.
2132 // When updating your code, note that (unlike the old versions) *all* the new routines take the target object
2133 // as their first parameter.
2134 //#define ConvertCStringToDomainName(SRC,DST)  MakeDomainNameFromDNSNameString((DST),(SRC))
2135 //#define ConvertCStringToDomainLabel(SRC,DST) MakeDomainLabelFromLiteralString((DST),(SRC))
2136 //#define AppendStringLabelToName(DST,SRC)     AppendLiteralLabelString((DST),(SRC))
2137 //#define AppendStringNameToName(DST,SRC)      AppendDNSNameString((DST),(SRC))
2138 //#define AppendDomainLabelToName(DST,SRC)     AppendDomainLabel((DST),(SRC))
2139 //#define AppendDomainNameToName(DST,SRC)      AppendDomainName((DST),(SRC))
2140
2141 // ***************************************************************************
2142 #if 0
2143 #pragma mark -
2144 #pragma mark - Other utility functions and macros
2145 #endif
2146
2147 // mDNS_vsnprintf/snprintf return the number of characters written, excluding the final terminating null.
2148 // The output is always null-terminated: for example, if the output turns out to be exactly buflen long,
2149 // then the output will be truncated by one character to allow space for the terminating null.
2150 // Unlike standard C vsnprintf/snprintf, they return the number of characters *actually* written,
2151 // not the number of characters that *would* have been printed were buflen unlimited.
2152 extern mDNSu32 mDNS_vsnprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, va_list arg);
2153 extern mDNSu32 mDNS_snprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, ...) IS_A_PRINTF_STYLE_FUNCTION(3,4);
2154 extern mDNSu32 NumCacheRecordsForInterfaceID(const mDNS *const m, mDNSInterfaceID id);
2155 extern char *DNSTypeName(mDNSu16 rrtype);
2156 extern char *GetRRDisplayString_rdb(const ResourceRecord *const rr, const RDataBody *const rd1, char *const buffer);
2157 #define RRDisplayString(m, rr) GetRRDisplayString_rdb(rr, &(rr)->rdata->u, (m)->MsgBuffer)
2158 #define ARDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer)
2159 #define CRDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer)
2160 extern mDNSBool mDNSSameAddress(const mDNSAddr *ip1, const mDNSAddr *ip2);
2161 extern void IncrementLabelSuffix(domainlabel *name, mDNSBool RichText);
2162 extern mDNSBool mDNSv4AddrIsRFC1918(mDNSv4Addr *addr);  // returns true for RFC1918 private addresses
2163 #define mDNSAddrIsRFC1918(X) ((X)->type == mDNSAddrType_IPv4 && mDNSv4AddrIsRFC1918(&(X)->ip.v4))
2164
2165 #define mDNSSameIPPort(A,B)      ((A).NotAnInteger == (B).NotAnInteger)
2166 #define mDNSSameOpaque16(A,B)    ((A).NotAnInteger == (B).NotAnInteger)
2167 #define mDNSSameOpaque32(A,B)    ((A).NotAnInteger == (B).NotAnInteger)
2168 #define mDNSSameOpaque64(A,B)    ((A)->l[0] == (B)->l[0] && (A)->l[1] == (B)->l[1])
2169
2170 #define mDNSSameIPv4Address(A,B) ((A).NotAnInteger == (B).NotAnInteger)
2171 #define mDNSSameIPv6Address(A,B) ((A).l[0] == (B).l[0] && (A).l[1] == (B).l[1] && (A).l[2] == (B).l[2] && (A).l[3] == (B).l[3])
2172 #define mDNSSameEthAddress(A,B)  ((A)->w[0] == (B)->w[0] && (A)->w[1] == (B)->w[1] && (A)->w[2] == (B)->w[2])
2173
2174 #define mDNSIPPortIsZero(A)      ((A).NotAnInteger                            == 0)
2175 #define mDNSOpaque16IsZero(A)    ((A).NotAnInteger                            == 0)
2176 #define mDNSOpaque64IsZero(A)    (((A)->l[0] | (A)->l[1]                    ) == 0)
2177 #define mDNSIPv4AddressIsZero(A) ((A).NotAnInteger                            == 0)
2178 #define mDNSIPv6AddressIsZero(A) (((A).l[0] | (A).l[1] | (A).l[2] | (A).l[3]) == 0)
2179 #define mDNSEthAddressIsZero(A)  (((A).w[0] | (A).w[1] | (A).w[2]           ) == 0)
2180
2181 #define mDNSIPv4AddressIsOnes(A) ((A).NotAnInteger == 0xFFFFFFFF)
2182 #define mDNSIPv6AddressIsOnes(A) (((A).l[0] & (A).l[1] & (A).l[2] & (A).l[3]) == 0xFFFFFFFF)
2183
2184 #define mDNSAddressIsAllDNSLinkGroup(X) (                                                            \
2185         ((X)->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address((X)->ip.v4, AllDNSLinkGroup_v4.ip.v4)) || \
2186         ((X)->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address((X)->ip.v6, AllDNSLinkGroup_v6.ip.v6))    )
2187
2188 #define mDNSAddressIsZero(X) (                                                \
2189         ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsZero((X)->ip.v4))  || \
2190         ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsZero((X)->ip.v6))     )
2191
2192 #define mDNSAddressIsValidNonZero(X) (                                        \
2193         ((X)->type == mDNSAddrType_IPv4 && !mDNSIPv4AddressIsZero((X)->ip.v4)) || \
2194         ((X)->type == mDNSAddrType_IPv6 && !mDNSIPv6AddressIsZero((X)->ip.v6))    )
2195
2196 #define mDNSAddressIsOnes(X) (                                                \
2197         ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsOnes((X)->ip.v4))  || \
2198         ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsOnes((X)->ip.v6))     )
2199
2200 #define mDNSAddressIsValid(X) (                                                                                             \
2201         ((X)->type == mDNSAddrType_IPv4) ? !(mDNSIPv4AddressIsZero((X)->ip.v4) || mDNSIPv4AddressIsOnes((X)->ip.v4)) :          \
2202         ((X)->type == mDNSAddrType_IPv6) ? !(mDNSIPv6AddressIsZero((X)->ip.v6) || mDNSIPv6AddressIsOnes((X)->ip.v6)) : mDNSfalse)
2203
2204 #define mDNSv4AddressIsLinkLocal(X) ((X)->b[0] ==  169 &&  (X)->b[1]         ==  254)
2205 #define mDNSv6AddressIsLinkLocal(X) ((X)->b[0] == 0xFE && ((X)->b[1] & 0xC0) == 0x80)
2206
2207 #define mDNSAddressIsLinkLocal(X)  (                                                    \
2208         ((X)->type == mDNSAddrType_IPv4) ? mDNSv4AddressIsLinkLocal(&(X)->ip.v4) :          \
2209         ((X)->type == mDNSAddrType_IPv6) ? mDNSv6AddressIsLinkLocal(&(X)->ip.v6) : mDNSfalse)
2210
2211 // ***************************************************************************
2212 #if 0
2213 #pragma mark -
2214 #pragma mark - Authentication Support
2215 #endif
2216
2217 // Unicast DNS and Dynamic Update specific Client Calls
2218 //
2219 // mDNS_SetSecretForDomain tells the core to authenticate (via TSIG with an HMAC_MD5 hash of the shared secret)
2220 // when dynamically updating a given zone (and its subdomains).  The key used in authentication must be in
2221 // domain name format.  The shared secret must be a null-terminated base64 encoded string.  A minimum size of
2222 // 16 bytes (128 bits) is recommended for an MD5 hash as per RFC 2485.
2223 // Calling this routine multiple times for a zone replaces previously entered values.  Call with a NULL key
2224 // to dissable authentication for the zone.
2225
2226 extern mStatus mDNS_SetSecretForDomain(mDNS *m, DomainAuthInfo *info,
2227         const domainname *domain, const domainname *keyname, const char *b64keydata, mDNSBool AutoTunnel);
2228
2229 extern void RecreateNATMappings(mDNS *const m);
2230
2231 // Hostname/Unicast Interface Configuration
2232
2233 // All hostnames advertised point to one IPv4 address and/or one IPv6 address, set via SetPrimaryInterfaceInfo.  Invoking this routine
2234 // updates all existing hostnames to point to the new address.
2235
2236 // A hostname is added via AddDynDNSHostName, which points to the primary interface's v4 and/or v6 addresss
2237
2238 // The status callback is invoked to convey success or failure codes - the callback should not modify the AuthRecord or free memory.
2239 // Added hostnames may be removed (deregistered) via mDNS_RemoveDynDNSHostName.
2240
2241 // Host domains added prior to specification of the primary interface address and computer name will be deferred until
2242 // these values are initialized.
2243
2244 // DNS servers used to resolve unicast queries are specified by mDNS_AddDNSServer.
2245 // For "split" DNS configurations, in which queries for different domains are sent to different servers (e.g. VPN and external),
2246 // a domain may be associated with a DNS server.  For standard configurations, specify the root label (".") or NULL.
2247
2248 extern void mDNS_AddDynDNSHostName(mDNS *m, const domainname *fqdn, mDNSRecordCallback *StatusCallback, const void *StatusContext);
2249 extern void mDNS_RemoveDynDNSHostName(mDNS *m, const domainname *fqdn);
2250 extern void mDNS_SetPrimaryInterfaceInfo(mDNS *m, const mDNSAddr *v4addr,  const mDNSAddr *v6addr, const mDNSAddr *router);
2251 extern DNSServer *mDNS_AddDNSServer(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, const mDNSAddr *addr, const mDNSIPPort port);
2252 extern void PenalizeDNSServer(mDNS *const m, DNSQuestion *q, mDNSBool QueryFail);
2253 extern void mDNS_AddSearchDomain(const domainname *const domain);
2254
2255 // We use ((void *)0) here instead of mDNSNULL to avoid compile warnings on gcc 4.2
2256 #define mDNS_AddSearchDomain_CString(X) \
2257         do { domainname d__; if (((X) != (void*)0) && MakeDomainNameFromDNSNameString(&d__, (X)) && d__.c[0]) mDNS_AddSearchDomain(&d__); } while(0)
2258
2259 // Routines called by the core, exported by DNSDigest.c
2260
2261 // Convert an arbitrary base64 encoded key key into an HMAC key (stored in AuthInfo struct)
2262 extern mDNSs32 DNSDigest_ConstructHMACKeyfromBase64(DomainAuthInfo *info, const char *b64key);
2263
2264 // sign a DNS message.  The message must be complete, with all values in network byte order.  end points to the end
2265 // of the message, and is modified by this routine.  numAdditionals is a pointer to the number of additional
2266 // records in HOST byte order, which is incremented upon successful completion of this routine.  The function returns
2267 // the new end pointer on success, and NULL on failure.
2268 extern void DNSDigest_SignMessage(DNSMessage *msg, mDNSu8 **end, DomainAuthInfo *info, mDNSu16 tcode);
2269
2270 #define SwapDNSHeaderBytes(M) do { \
2271     (M)->h.numQuestions   = (mDNSu16)((mDNSu8 *)&(M)->h.numQuestions  )[0] << 8 | ((mDNSu8 *)&(M)->h.numQuestions  )[1]; \
2272     (M)->h.numAnswers     = (mDNSu16)((mDNSu8 *)&(M)->h.numAnswers    )[0] << 8 | ((mDNSu8 *)&(M)->h.numAnswers    )[1]; \
2273     (M)->h.numAuthorities = (mDNSu16)((mDNSu8 *)&(M)->h.numAuthorities)[0] << 8 | ((mDNSu8 *)&(M)->h.numAuthorities)[1]; \
2274     (M)->h.numAdditionals = (mDNSu16)((mDNSu8 *)&(M)->h.numAdditionals)[0] << 8 | ((mDNSu8 *)&(M)->h.numAdditionals)[1]; \
2275     } while (0)
2276
2277 #define DNSDigest_SignMessageHostByteOrder(M,E,INFO) \
2278         do { SwapDNSHeaderBytes(M); DNSDigest_SignMessage((M), (E), (INFO), 0); SwapDNSHeaderBytes(M); } while (0)
2279
2280 // verify a DNS message.  The message must be complete, with all values in network byte order.  end points to the
2281 // end of the record.  tsig is a pointer to the resource record that contains the TSIG OPT record.  info is
2282 // the matching key to use for verifying the message.  This function expects that the additionals member
2283 // of the DNS message header has already had one subtracted from it.
2284 extern mDNSBool DNSDigest_VerifyMessage(DNSMessage *msg, mDNSu8 *end, LargeCacheRecord *tsig, DomainAuthInfo *info, mDNSu16 *rcode, mDNSu16 *tcode);
2285
2286 // ***************************************************************************
2287 #if 0
2288 #pragma mark -
2289 #pragma mark - PlatformSupport interface
2290 #endif
2291
2292 // This section defines the interface to the Platform Support layer.
2293 // Normal client code should not use any of types defined here, or directly call any of the functions defined here.
2294 // The definitions are placed here because sometimes clients do use these calls indirectly, via other supported client operations.
2295 // For example, AssignDomainName is a macro defined using mDNSPlatformMemCopy()
2296
2297 // Every platform support module must provide the following functions.
2298 // mDNSPlatformInit() typically opens a communication endpoint, and starts listening for mDNS packets.
2299 // When Setup is complete, the platform support layer calls mDNSCoreInitComplete().
2300 // mDNSPlatformSendUDP() sends one UDP packet
2301 // When a packet is received, the PlatformSupport code calls mDNSCoreReceive()
2302 // mDNSPlatformClose() tidies up on exit
2303 //
2304 // Note: mDNSPlatformMemAllocate/mDNSPlatformMemFree are only required for handling oversized resource records and unicast DNS.
2305 // If your target platform has a well-defined specialized application, and you know that all the records it uses
2306 // are InlineCacheRDSize or less, then you can just make a simple mDNSPlatformMemAllocate() stub that always returns
2307 // NULL. InlineCacheRDSize is a compile-time constant, which is set by default to 68. If you need to handle records
2308 // a little larger than this and you don't want to have to implement run-time allocation and freeing, then you
2309 // can raise the value of this constant to a suitable value (at the expense of increased memory usage).
2310 //
2311 // USE CAUTION WHEN CALLING mDNSPlatformRawTime: The m->timenow_adjust correction factor needs to be added
2312 // Generally speaking:
2313 // Code that's protected by the main mDNS lock should just use the m->timenow value
2314 // Code outside the main mDNS lock should use mDNS_TimeNow(m) to get properly adjusted time
2315 // In certain cases there may be reasons why it's necessary to get the time without taking the lock first
2316 // (e.g. inside the routines that are doing the locking and unlocking, where a call to get the lock would result in a
2317 // recursive loop); in these cases use mDNS_TimeNow_NoLock(m) to get mDNSPlatformRawTime with the proper correction factor added.
2318 //
2319 // mDNSPlatformUTC returns the time, in seconds, since Jan 1st 1970 UTC and is required for generating TSIG records
2320
2321 extern mStatus  mDNSPlatformInit        (mDNS *const m);
2322 extern void     mDNSPlatformClose       (mDNS *const m);
2323 extern mStatus  mDNSPlatformSendUDP(const mDNS *const m, const void *const msg, const mDNSu8 *const end,
2324 mDNSInterfaceID InterfaceID, UDPSocket *src, const mDNSAddr *dst, mDNSIPPort dstport);
2325
2326 extern void     mDNSPlatformLock        (const mDNS *const m);
2327 extern void     mDNSPlatformUnlock      (const mDNS *const m);
2328
2329 extern void     mDNSPlatformStrCopy     (      void *dst, const void *src);
2330 extern mDNSu32  mDNSPlatformStrLen      (                 const void *src);
2331 extern void     mDNSPlatformMemCopy     (      void *dst, const void *src, mDNSu32 len);
2332 extern mDNSBool mDNSPlatformMemSame     (const void *dst, const void *src, mDNSu32 len);
2333 extern void     mDNSPlatformMemZero     (      void *dst,                  mDNSu32 len);
2334 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING
2335 #define         mDNSPlatformMemAllocate(X) mallocL(#X, X)
2336 #else
2337 extern void *   mDNSPlatformMemAllocate (mDNSu32 len);
2338 #endif
2339 extern void     mDNSPlatformMemFree     (void *mem);
2340
2341 // If the platform doesn't have a strong PRNG, we define a naive multiply-and-add based on a seed
2342 // from the platform layer.  Long-term, we should embed an arc4 implementation, but the strength
2343 // will still depend on the randomness of the seed.
2344 #if !defined(_PLATFORM_HAS_STRONG_PRNG_) && (_BUILDING_XCODE_PROJECT_ || defined(_WIN32))
2345 #define _PLATFORM_HAS_STRONG_PRNG_ 1
2346 #endif
2347 #if _PLATFORM_HAS_STRONG_PRNG_
2348 extern mDNSu32  mDNSPlatformRandomNumber(void);
2349 #else
2350 extern mDNSu32  mDNSPlatformRandomSeed  (void);
2351 #endif // _PLATFORM_HAS_STRONG_PRNG_
2352
2353 extern mStatus  mDNSPlatformTimeInit    (void);
2354 extern mDNSs32  mDNSPlatformRawTime     (void);
2355 extern mDNSs32  mDNSPlatformUTC         (void);
2356 #define mDNS_TimeNow_NoLock(m) (mDNSPlatformRawTime() + (m)->timenow_adjust)
2357
2358 #if MDNS_DEBUGMSGS
2359 extern void     mDNSPlatformWriteDebugMsg(const char *msg);
2360 #endif
2361 extern void     mDNSPlatformWriteLogMsg(const char *ident, const char *msg, mDNSLogLevel_t loglevel);
2362
2363 #if APPLE_OSX_mDNSResponder
2364 // Utility function for ASL logging
2365 mDNSexport void mDNSASLLog(uuid_t *uuid, const char *subdomain, const char *result, const char *signature, const char *fmt, ...);
2366 #endif
2367
2368 // Platform support modules should provide the following functions to map between opaque interface IDs
2369 // and interface indexes in order to support the DNS-SD API. If your target platform does not support
2370 // multiple interfaces and/or does not support the DNS-SD API, these functions can be empty.
2371 extern mDNSInterfaceID mDNSPlatformInterfaceIDfromInterfaceIndex(mDNS *const m, mDNSu32 ifindex);
2372 extern mDNSu32 mDNSPlatformInterfaceIndexfromInterfaceID(mDNS *const m, mDNSInterfaceID id);
2373
2374 // Every platform support module must provide the following functions if it is to support unicast DNS
2375 // and Dynamic Update.
2376 // All TCP socket operations implemented by the platform layer MUST NOT BLOCK.
2377 // mDNSPlatformTCPConnect initiates a TCP connection with a peer, adding the socket descriptor to the
2378 // main event loop.  The return value indicates whether the connection succeeded, failed, or is pending
2379 // (i.e. the call would block.)  On return, the descriptor parameter is set to point to the connected socket.
2380 // The TCPConnectionCallback is subsequently invoked when the connection
2381 // completes (in which case the ConnectionEstablished parameter is true), or data is available for
2382 // reading on the socket (indicated by the ConnectionEstablished parameter being false.)  If the connection
2383 // asynchronously fails, the TCPConnectionCallback should be invoked as usual, with the error being
2384 // returned in subsequent calls to PlatformReadTCP or PlatformWriteTCP.  (This allows for platforms
2385 // with limited asynchronous error detection capabilities.)  PlatformReadTCP and PlatformWriteTCP must
2386 // return the number of bytes read/written, 0 if the call would block, and -1 if an error.  PlatformReadTCP
2387 // should set the closed argument if the socket has been closed.
2388 // PlatformTCPCloseConnection must close the connection to the peer and remove the descriptor from the
2389 // event loop.  CloseConnectin may be called at any time, including in a ConnectionCallback.
2390
2391 typedef enum
2392         {
2393         kTCPSocketFlags_Zero   = 0,
2394         kTCPSocketFlags_UseTLS = (1 << 0)
2395         } TCPSocketFlags;
2396
2397 typedef void (*TCPConnectionCallback)(TCPSocket *sock, void *context, mDNSBool ConnectionEstablished, mStatus err);
2398 extern TCPSocket *mDNSPlatformTCPSocket(mDNS *const m, TCPSocketFlags flags, mDNSIPPort *port); // creates a TCP socket
2399 extern TCPSocket *mDNSPlatformTCPAccept(TCPSocketFlags flags, int sd);
2400 extern int        mDNSPlatformTCPGetFD(TCPSocket *sock);
2401 extern mStatus    mDNSPlatformTCPConnect(TCPSocket *sock, const mDNSAddr *dst, mDNSOpaque16 dstport, mDNSInterfaceID InterfaceID,
2402                                          TCPConnectionCallback callback, void *context);
2403 extern void       mDNSPlatformTCPCloseConnection(TCPSocket *sock);
2404 extern long       mDNSPlatformReadTCP(TCPSocket *sock, void *buf, unsigned long buflen, mDNSBool *closed);
2405 extern long       mDNSPlatformWriteTCP(TCPSocket *sock, const char *msg, unsigned long len);
2406 extern UDPSocket *mDNSPlatformUDPSocket(mDNS *const m, const mDNSIPPort requestedport);
2407 extern void       mDNSPlatformUDPClose(UDPSocket *sock);
2408 extern void       mDNSPlatformReceiveBPF_fd(mDNS *const m, int fd);
2409 extern void       mDNSPlatformUpdateProxyList(mDNS *const m, const mDNSInterfaceID InterfaceID);
2410 extern void       mDNSPlatformSendRawPacket(const void *const msg, const mDNSu8 *const end, mDNSInterfaceID InterfaceID);
2411 extern void       mDNSPlatformSetLocalARP(const mDNSv4Addr *const tpa, const mDNSEthAddr *const tha, mDNSInterfaceID InterfaceID);
2412 extern void       mDNSPlatformSourceAddrForDest(mDNSAddr *const src, const mDNSAddr *const dst);
2413
2414 // mDNSPlatformTLSSetupCerts/mDNSPlatformTLSTearDownCerts used by dnsextd
2415 extern mStatus    mDNSPlatformTLSSetupCerts(void);
2416 extern void       mDNSPlatformTLSTearDownCerts(void);
2417
2418 // Platforms that support unicast browsing and dynamic update registration for clients who do not specify a domain
2419 // in browse/registration calls must implement these routines to get the "default" browse/registration list.
2420
2421 extern void       mDNSPlatformSetDNSConfig(mDNS *const m, mDNSBool setservers, mDNSBool setsearch, domainname *const fqdn, DNameListElem **RegDomains, DNameListElem **BrowseDomains);
2422 extern mStatus    mDNSPlatformGetPrimaryInterface(mDNS *const m, mDNSAddr *v4, mDNSAddr *v6, mDNSAddr *router);
2423 extern void       mDNSPlatformDynDNSHostNameStatusChanged(const domainname *const dname, const mStatus status);
2424
2425 #ifdef _LEGACY_NAT_TRAVERSAL_
2426 // Support for legacy NAT traversal protocols, implemented by the platform layer and callable by the core.
2427 extern void     LNT_SendDiscoveryMsg(mDNS *m);
2428 extern void     LNT_ConfigureRouterInfo(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *data, mDNSu16 len);
2429 extern mStatus  LNT_GetExternalAddress(mDNS *m);
2430 extern mStatus  LNT_MapPort(mDNS *m, NATTraversalInfo *n);
2431 extern mStatus  LNT_UnmapPort(mDNS *m, NATTraversalInfo *n);
2432 extern void     LNT_ClearState(mDNS *const m);
2433 #endif // _LEGACY_NAT_TRAVERSAL_
2434
2435 // The core mDNS code provides these functions, for the platform support code to call at appropriate times
2436 //
2437 // mDNS_SetFQDN() is called once on startup (typically from mDNSPlatformInit())
2438 // and then again on each subsequent change of the host name.
2439 //
2440 // mDNS_RegisterInterface() is used by the platform support layer to inform mDNSCore of what
2441 // physical and/or logical interfaces are available for sending and receiving packets.
2442 // Typically it is called on startup for each available interface, but register/deregister may be
2443 // called again later, on multiple occasions, to inform the core of interface configuration changes.
2444 // If set->Advertise is set non-zero, then mDNS_RegisterInterface() also registers the standard
2445 // resource records that should be associated with every publicised IP address/interface:
2446 // -- Name-to-address records (A/AAAA)
2447 // -- Address-to-name records (PTR)
2448 // -- Host information (HINFO)
2449 // IMPORTANT: The specified mDNSInterfaceID MUST NOT be 0, -1, or -2; these values have special meaning
2450 // mDNS_RegisterInterface does not result in the registration of global hostnames via dynamic update -
2451 // see mDNS_SetPrimaryInterfaceInfo, mDNS_AddDynDNSHostName, etc. for this purpose.
2452 // Note that the set may be deallocated immediately after it is deregistered via mDNS_DeegisterInterface.
2453 //
2454 // mDNS_RegisterDNS() is used by the platform support layer to provide the core with the addresses of
2455 // available domain name servers for unicast queries/updates.  RegisterDNS() should be called once for
2456 // each name server, typically at startup, or when a new name server becomes available.  DeregiterDNS()
2457 // must be called whenever a registered name server becomes unavailable.  DeregisterDNSList deregisters
2458 // all registered servers.  mDNS_DNSRegistered() returns true if one or more servers are registered in the core.
2459 //
2460 // mDNSCoreInitComplete() is called when the platform support layer is finished.
2461 // Typically this is at the end of mDNSPlatformInit(), but may be later
2462 // (on platforms like OT that allow asynchronous initialization of the networking stack).
2463 //
2464 // mDNSCoreReceive() is called when a UDP packet is received
2465 //
2466 // mDNSCoreMachineSleep() is called when the machine sleeps or wakes
2467 // (This refers to heavyweight laptop-style sleep/wake that disables network access,
2468 // not lightweight second-by-second CPU power management modes.)
2469
2470 extern void     mDNS_SetFQDN(mDNS *const m);
2471 extern void     mDNS_ActivateNetWake_internal  (mDNS *const m, NetworkInterfaceInfo *set);
2472 extern void     mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set);
2473 extern mStatus  mDNS_RegisterInterface  (mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping);
2474 extern void     mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping);
2475 extern void     mDNSCoreInitComplete(mDNS *const m, mStatus result);
2476 extern void     mDNSCoreReceive(mDNS *const m, void *const msg, const mDNSu8 *const end,
2477                                                                 const mDNSAddr *const srcaddr, const mDNSIPPort srcport,
2478                                                                 const mDNSAddr *dstaddr, const mDNSIPPort dstport, const mDNSInterfaceID InterfaceID);
2479 extern void     mDNSCoreRestartQueries(mDNS *const m);
2480 extern mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m);
2481 extern void     mDNSCoreMachineSleep(mDNS *const m, mDNSBool wake);
2482 extern mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now);
2483 extern mDNSs32  mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now);
2484
2485 extern void     mDNSCoreBeSleepProxyServer(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower);
2486 extern void     mDNSCoreReceiveRawPacket  (mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID);
2487
2488 extern mDNSBool mDNSAddrIsDNSMulticast(const mDNSAddr *ip);
2489
2490 extern CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg);
2491 extern void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease);
2492 extern void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr,
2493         const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds, mDNSInterfaceID InterfaceID);
2494 extern void CompleteDeregistration(mDNS *const m, AuthRecord *rr);
2495 extern void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3]);
2496 #define PrototypeSPSName(X) ((X)[0] >= 11 && (X)[3] == '-' && (X)[ 4] == '9' && (X)[ 5] == '9' && \
2497                                              (X)[6] == '-' && (X)[ 7] == '9' && (X)[ 8] == '9' && \
2498                                              (X)[9] == '-' && (X)[10] == '9' && (X)[11] == '9'    )
2499 #define ValidSPSName(X) ((X)[0] >= 5 && mDNSIsDigit((X)[1]) && mDNSIsDigit((X)[2]) && mDNSIsDigit((X)[4]) && mDNSIsDigit((X)[5]))
2500 #define SPSMetric(X) (!ValidSPSName(X) || PrototypeSPSName(X) ? 1000000 : \
2501         ((X)[1]-'0') * 100000 + ((X)[2]-'0') * 10000 + ((X)[4]-'0') * 1000 + ((X)[5]-'0') * 100 + ((X)[7]-'0') * 10 + ((X)[8]-'0'))
2502 extern void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord);
2503
2504 // For now this AutoTunnel stuff is specific to Mac OS X.
2505 // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
2506 #if APPLE_OSX_mDNSResponder
2507 extern void AutoTunnelCallback(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord);
2508 extern void AddNewClientTunnel(mDNS *const m, DNSQuestion *const q);
2509 extern void SetupLocalAutoTunnelInterface_internal(mDNS *const m);
2510 extern void UpdateAutoTunnelDomainStatuses(const mDNS *const m);
2511 extern mStatus ActivateLocalProxy(mDNS *const m, char *ifname);
2512 #endif
2513
2514 // ***************************************************************************
2515 #if 0
2516 #pragma mark -
2517 #pragma mark - Compile-Time assertion checks
2518 #endif
2519
2520 // Some C compiler cleverness. We can make the compiler check certain things for
2521 // us, and report compile-time errors if anything is wrong. The usual way to do
2522 // this would be to use a run-time "if" statement, but then you don't find out
2523 // what's wrong until you run the software. This way, if the assertion condition
2524 // is false, the array size is negative, and the complier complains immediately.
2525
2526 struct CompileTimeAssertionChecks_mDNS
2527         {
2528         // Check that the compiler generated our on-the-wire packet format structure definitions
2529         // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries.
2530         char assert0[(sizeof(rdataSRV)         == 262                          ) ? 1 : -1];
2531         char assert1[(sizeof(DNSMessageHeader) ==  12                          ) ? 1 : -1];
2532         char assert2[(sizeof(DNSMessage)       ==  12+AbsoluteMaxDNSMessageData) ? 1 : -1];
2533         char assert3[(sizeof(mDNSs8)           ==   1                          ) ? 1 : -1];
2534         char assert4[(sizeof(mDNSu8)           ==   1                          ) ? 1 : -1];
2535         char assert5[(sizeof(mDNSs16)          ==   2                          ) ? 1 : -1];
2536         char assert6[(sizeof(mDNSu16)          ==   2                          ) ? 1 : -1];
2537         char assert7[(sizeof(mDNSs32)          ==   4                          ) ? 1 : -1];
2538         char assert8[(sizeof(mDNSu32)          ==   4                          ) ? 1 : -1];
2539         char assert9[(sizeof(mDNSOpaque16)     ==   2                          ) ? 1 : -1];
2540         char assertA[(sizeof(mDNSOpaque32)     ==   4                          ) ? 1 : -1];
2541         char assertB[(sizeof(mDNSOpaque128)    ==  16                          ) ? 1 : -1];
2542         char assertC[(sizeof(CacheRecord  )    ==  sizeof(CacheGroup)          ) ? 1 : -1];
2543         char assertD[(sizeof(int)              >=  4                           ) ? 1 : -1];
2544         char assertE[(StandardAuthRDSize       >=  256                         ) ? 1 : -1];
2545         char assertF[(sizeof(EthernetHeader)   ==   14                         ) ? 1 : -1];
2546         char assertG[(sizeof(ARP_EthIP     )   ==   28                         ) ? 1 : -1];
2547         char assertH[(sizeof(IPv4Header    )   ==   20                         ) ? 1 : -1];
2548         char assertI[(sizeof(IPv6Header    )   ==   40                         ) ? 1 : -1];
2549         char assertJ[(sizeof(IPv6ND        )   ==   24                         ) ? 1 : -1];
2550         char assertK[(sizeof(UDPHeader     )   ==    8                         ) ? 1 : -1];
2551         char assertL[(sizeof(IKEHeader     )   ==   28                         ) ? 1 : -1];
2552         char assertM[(sizeof(TCPHeader     )   ==   20                         ) ? 1 : -1];
2553
2554         // Check our structures are reasonable sizes. Including overly-large buffers, or embedding
2555         // other overly-large structures instead of having a pointer to them, can inadvertently
2556         // cause structure sizes (and therefore memory usage) to balloon unreasonably.
2557         char sizecheck_RDataBody           [(sizeof(RDataBody)            ==   264) ? 1 : -1];
2558         char sizecheck_ResourceRecord      [(sizeof(ResourceRecord)       <=    56) ? 1 : -1];
2559         char sizecheck_AuthRecord          [(sizeof(AuthRecord)           <=  1000) ? 1 : -1];
2560         char sizecheck_CacheRecord         [(sizeof(CacheRecord)          <=   176) ? 1 : -1];
2561         char sizecheck_CacheGroup          [(sizeof(CacheGroup)           <=   176) ? 1 : -1];
2562         char sizecheck_DNSQuestion         [(sizeof(DNSQuestion)          <=   728) ? 1 : -1];
2563         char sizecheck_ZoneData            [(sizeof(ZoneData)             <=  1560) ? 1 : -1];
2564         char sizecheck_NATTraversalInfo    [(sizeof(NATTraversalInfo)     <=   192) ? 1 : -1];
2565         char sizecheck_HostnameInfo        [(sizeof(HostnameInfo)         <=  2800) ? 1 : -1];
2566         char sizecheck_DNSServer           [(sizeof(DNSServer)            <=   312) ? 1 : -1];
2567         char sizecheck_NetworkInterfaceInfo[(sizeof(NetworkInterfaceInfo) <=  5968) ? 1 : -1];
2568         char sizecheck_ServiceRecordSet    [(sizeof(ServiceRecordSet)     <=  5500) ? 1 : -1];
2569         char sizecheck_DomainAuthInfo      [(sizeof(DomainAuthInfo)       <=  5500) ? 1 : -1];
2570         char sizecheck_ServiceInfoQuery    [(sizeof(ServiceInfoQuery)     <=  2944) ? 1 : -1];
2571 #if APPLE_OSX_mDNSResponder
2572         char sizecheck_ClientTunnel        [(sizeof(ClientTunnel)         <=  1072) ? 1 : -1];
2573 #endif
2574         };
2575
2576 // ***************************************************************************
2577
2578 #ifdef __cplusplus
2579         }
2580 #endif
2581
2582 #endif