209f3982a991b834c5fe841001f49103b3054fe3
[people/sha0/mDNSResponder.git] / mDNSCore / uDNS.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
18 #ifndef __UDNS_H_
19 #define __UDNS_H_
20
21 #include "mDNSEmbeddedAPI.h"
22 #include "DNSCommon.h"
23
24 #ifdef  __cplusplus
25         extern "C" {
26 #endif
27
28 #define RESTART_GOODBYE_DELAY    (6 * mDNSPlatformOneSecond) // delay after restarting LLQ before nuking previous known answers (avoids flutter if we restart before we have networking up)
29 #define INIT_UCAST_POLL_INTERVAL (3 * mDNSPlatformOneSecond) // this interval is used after send failures on network transitions
30                                                                  // which typically heal quickly, so we start agressively and exponentially back off
31 #define MAX_UCAST_POLL_INTERVAL (60 * 60 * mDNSPlatformOneSecond)
32 //#define MAX_UCAST_POLL_INTERVAL (1 * 60 * mDNSPlatformOneSecond)
33 #define LLQ_POLL_INTERVAL       (15 * 60 * mDNSPlatformOneSecond) // Polling interval for zones w/ an advertised LLQ port (ie not static zones) if LLQ fails due to NAT, etc.
34 #define RESPONSE_WINDOW (60 * mDNSPlatformOneSecond)         // require server responses within one minute of request
35 #define MAX_UCAST_UNANSWERED_QUERIES 2                       // the number of unanswered queries from any one uDNS server before trying another server
36
37 #define DEFAULT_UPDATE_LEASE 7200
38
39 #define QuestionIntervalStep 3
40 #define QuestionIntervalStep2 (QuestionIntervalStep*QuestionIntervalStep)
41 #define QuestionIntervalStep3 (QuestionIntervalStep*QuestionIntervalStep*QuestionIntervalStep)
42 #define InitialQuestionInterval ((mDNSPlatformOneSecond + QuestionIntervalStep-1) / QuestionIntervalStep)
43
44 // Entry points into unicast-specific routines
45
46 extern void LLQGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneInfo);
47 extern void startLLQHandshake(mDNS *m, DNSQuestion *q);
48 extern void sendLLQRefresh(mDNS *m, DNSQuestion *q);
49
50 extern void SleepServiceRegistrations(mDNS *m);
51 extern void SleepRecordRegistrations(mDNS *m);
52
53 // uDNS_UpdateRecord
54 // following fields must be set, and the update validated, upon entry.
55 // rr->NewRData
56 // rr->newrdlength
57 // rr->UpdateCallback
58
59 extern mStatus uDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra);
60 extern mStatus uDNS_UpdateRecord(mDNS *m, AuthRecord *rr);
61
62 extern void SetNextQueryTime(mDNS *const m, const DNSQuestion *const q);
63 extern CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name);
64 extern mStatus mDNS_Register_internal(mDNS *const m, AuthRecord *const rr);
65 // mDNS_Dereg_normal is used for most calls to mDNS_Deregister_internal
66 // mDNS_Dereg_conflict is used to indicate that this record is being forcibly deregistered because of a conflict
67 // mDNS_Dereg_repeat is used when cleaning up, for records that may have already been forcibly deregistered
68 typedef enum { mDNS_Dereg_normal, mDNS_Dereg_conflict, mDNS_Dereg_repeat } mDNS_Dereg_type;
69 extern mStatus mDNS_Deregister_internal(mDNS *const m, AuthRecord *const rr, mDNS_Dereg_type drt);
70 extern mStatus mDNS_StartQuery_internal(mDNS *const m, DNSQuestion *const question);
71 extern mStatus mDNS_StopQuery_internal(mDNS *const m, DNSQuestion *const question);
72 extern mStatus mDNS_StartNATOperation_internal(mDNS *const m, NATTraversalInfo *traversal);
73
74 extern void RecordRegistrationGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneData);
75 extern mStatus uDNS_DeregisterRecord(mDNS *const m, AuthRecord *const rr);
76
77 extern void ServiceRegistrationGotZoneData(mDNS *const m, mStatus err, const ZoneData *result);
78 extern const domainname *GetServiceTarget(mDNS *m, AuthRecord *const rr);
79 extern mStatus uDNS_DeregisterService(mDNS *const m, ServiceRecordSet *srs);
80
81 extern void uDNS_CheckCurrentQuestion(mDNS *const m);
82
83 // integer fields of msg header must be in HOST byte order before calling this routine
84 extern void uDNS_ReceiveMsg(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end,
85         const mDNSAddr *const srcaddr, const mDNSIPPort srcport);
86
87 // returns time of next scheduled event
88 extern void uDNS_Execute(mDNS *const m);
89
90 extern mStatus         uDNS_SetupDNSConfig(mDNS *const m);
91 extern mStatus         uDNS_RegisterSearchDomains(mDNS *const m);
92
93 typedef enum
94         {
95         uDNS_LLQ_Not = 0,       // Normal uDNS answer: Flush any stale records from cache, and respect record TTL
96         uDNS_LLQ_Ignore,        // LLQ initial challenge packet: ignore -- has no useful records for us
97         uDNS_LLQ_Entire,        // LLQ initial set of answers: Flush any stale records from cache, but assume TTL is 2 x LLQ refresh interval
98         uDNS_LLQ_Events         // LLQ event packet: don't flush cache; assume TTL is 2 x LLQ refresh interval
99         } uDNS_LLQType;
100
101 extern uDNS_LLQType    uDNS_recvLLQResponse(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end, const mDNSAddr *const srcaddr, const mDNSIPPort srcport);
102 extern DomainAuthInfo *GetAuthInfoForName_internal(mDNS *m, const domainname *const name);
103 extern DomainAuthInfo *GetAuthInfoForQuestion(mDNS *m, const DNSQuestion *const q);
104 extern void DisposeTCPConn(struct tcpInfo_t *tcp);
105
106 // NAT traversal
107 extern void     uDNS_ReceiveNATPMPPacket(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *pkt, mDNSu16 len); // Called for each received NAT-PMP packet
108 extern void     natTraversalHandleAddressReply(mDNS *const m, mDNSu16 err, mDNSv4Addr ExtAddr);
109 extern void     natTraversalHandlePortMapReply(mDNS *const m, NATTraversalInfo *n, const mDNSInterfaceID InterfaceID, mDNSu16 err, mDNSIPPort extport, mDNSu32 lease);
110
111 #ifdef  __cplusplus
112         }
113 #endif
114
115 #endif // __UDNS_H_