mDNSWindows/mDNSWin32.h

   1 /*
   2  * Copyright (c) 2002-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22
  23     Change History (most recent first):
  24
  25 $Log: mDNSWin32.h,v $
  26 Revision 1.23  2005/10/05 20:55:14  herscher
  27 <rdar://problem/4096464> Don't call SetLLRoute on loopback interface
  28
  29 Revision 1.22  2005/03/04 22:44:53  shersche
  30 <rdar://problem/4022802> mDNSResponder did not notice changes to DNS server config
  31
  32 Revision 1.21  2005/03/03 02:29:00  shersche
  33 Use the RegNames.h header file for registry key names
  34
  35 Revision 1.20  2005/01/25 08:12:52  shersche
  36 <rdar://problem/3947417> Enable Unicast and add Dynamic DNS support.
  37 Bug #: 3947417
  38
  39 Revision 1.19  2004/12/15 07:34:45  shersche
  40 Add platform support for IPv4 and IPv6 unicast sockets
  41
  42 Revision 1.18  2004/10/11 21:53:15  shersche
  43 <rdar://problem/3832450> Change GetWindowsVersionString link scoping from static to non-static so that it can be accessed from other compilation units. The information returned in this function will be used to determine what service dependencies to use when calling CreateService().
  44 Bug #: 3832450
  45
  46 Revision 1.17  2004/09/17 01:08:57  cheshire
  47 Renamed mDNSClientAPI.h to mDNSEmbeddedAPI.h
  48   The name "mDNSClientAPI.h" is misleading to new developers looking at this code. The interfaces
  49   declared in that file are ONLY appropriate to single-address-space embedded applications.
  50   For clients on general-purpose computers, the interfaces defined in dns_sd.h should be used.
  51
  52 Revision 1.16  2004/08/05 05:43:01  shersche
  53 <rdar://problem/3751566> Add HostDescriptionChangedCallback so callers can choose to handle it when mDNSWin32 core detects that the computer description string has changed
  54 Bug #: 3751566
  55
  56 Revision 1.15  2004/07/26 05:42:50  shersche
  57 use "Computer Description" for nicename if available, track dynamic changes to "Computer Description"
  58
  59 Revision 1.14  2004/07/13 21:24:25  rpantos
  60 Fix for <rdar://problem/3701120>.
  61
  62 Revision 1.13  2004/06/24 15:23:24  shersche
  63 Add InterfaceListChanged callback.  This callback is used in Service.c to add link local routes to the routing table
  64 Submitted by: herscher
  65
  66 Revision 1.12  2004/06/18 05:22:16  rpantos
  67 Integrate Scott's changes
  68
  69 Revision 1.11  2004/01/30 02:44:32  bradley
  70 Added support for IPv6 (v4 & v6, v4-only, v6-only, AAAA over v4, etc.). Added support for DNS-SD
  71 InterfaceID<->Interface Index mappings. Added support for loopback usage when no other interfaces
  72 are available. Updated unlock signaling to no longer require timenow - NextScheduledTime to be >= 0
  73 (it no longer is). Added unicast-capable detection to avoid using unicast when there is other mDNS
  74 software running on the same machine. Removed unneeded sock_XtoY routines. Added support for
  75 reporting HINFO records with the  Windows and mDNSResponder version information.
  76
  77 Revision 1.10  2003/10/24 23:23:02  bradley
  78 Removed legacy port 53 support as it is no longer needed.
  79
  80 Revision 1.9  2003/08/20 06:21:25  bradley
  81 Updated to latest internal version of the mDNSWindows platform layer: Added support
  82 for Windows CE/PocketPC 2003; re-did interface-related code to emulate getifaddrs/freeifaddrs for
  83 restricting usage to only active, multicast-capable, and non-point-to-point interfaces and to ease
  84 the addition of IPv6 support in the future; Changed init code to serialize thread initialization to
  85 enable ThreadID improvement to wakeup notification; Define platform support structure locally to
  86 allow portable mDNS_Init usage; Removed dependence on modified mDNSCore: define interface ID<->name
  87 structures/prototypes locally; Changed to use _beginthreadex()/_endthreadex() on non-Windows CE
  88 platforms (re-mapped to CreateThread on Window CE) to avoid a leak in the Microsoft C runtime;
  89 Added IPv4/IPv6 string<->address conversion routines; Cleaned up some code and added HeaderDoc.
  90
  91 Revision 1.8  2003/08/12 19:56:27  cheshire
  92 Update to APSL 2.0
  93
  94 Revision 1.7  2003/07/23 02:23:01  cheshire
  95 Updated mDNSPlatformUnlock() to work correctly, now that <rdar://problem/3160248>
  96 "ScheduleNextTask needs to be smarter" has refined the way m->NextScheduledEvent is set
  97
  98 Revision 1.6  2003/07/02 21:20:04  cheshire
  99 <rdar://problem/3313413> Update copyright notices, etc., in source code comments
 100
 101 Revision 1.5  2003/04/29 00:06:09  cheshire
 102 <rdar://problem/3242673> mDNSWindows needs a wakeupEvent object to signal the main thread
 103
 104 Revision 1.4  2003/03/22 02:57:44  cheshire
 105 Updated mDNSWindows to use new "mDNS_Execute" model (see "mDNSCore/Implementer Notes.txt")
 106
 107 Revision 1.3  2002/09/21 20:44:54  zarzycki
 108 Added APSL info
 109
 110 Revision 1.2  2002/09/20 05:55:16  bradley
 111 Multicast DNS platform plugin for Win32
 112
 113 */
 114
 115 #ifndef __MDNS_WIN32__
 116 #define __MDNS_WIN32__
 117
 118 #include        "CommonServices.h"
 119
 120 #if( !defined( _WIN32_WCE ) )
 121         #include        <mswsock.h>
 122 #endif
 123
 124 #include        "mDNSEmbeddedAPI.h"
 125 #include        "dDNS.h"
 126
 127 #ifdef  __cplusplus
 128         extern "C" {
 129 #endif
 130
 131 //---------------------------------------------------------------------------------------------------------------------------
 132 /*!     @struct         mDNSInterfaceData
 133
 134         @abstract       Structure containing interface-specific data.
 135 */
 136
 137 typedef struct  mDNSInterfaceData       mDNSInterfaceData;
 138 struct  mDNSInterfaceData
 139 {
 140         mDNSInterfaceData *                     next;
 141         char                                            name[ 128 ];
 142         uint32_t                                        index;
 143         uint32_t                                        scopeID;
 144         SocketRef                                       sock;
 145 #if( !defined( _WIN32_WCE ) )
 146         LPFN_WSARECVMSG                         wsaRecvMsgFunctionPtr;
 147 #endif
 148         HANDLE                                          readPendingEvent;
 149         NetworkInterfaceInfo            interfaceInfo;
 150         mDNSAddr                                        defaultAddr;
 151         mDNSBool                                        hostRegistered;
 152 };
 153
 154 //---------------------------------------------------------------------------------------------------------------------------
 155 /*!     @typedef        IdleThreadCallback
 156
 157         @abstract       mDNSWin32 core will call out through this function pointer
 158                                 after calling mDNS_Execute
 159 */
 160 typedef mDNSs32 (*IdleThreadCallback)(mDNS * const inMDNS, mDNSs32 interval);
 161 //---------------------------------------------------------------------------------------------------------------------------
 162
 163 //---------------------------------------------------------------------------------------------------------------------------
 164 /*!     @typedef        InterfaceListChangedCallback
 165
 166         @abstract       mDNSWin32 core will call out through this function pointer
 167                                 after detecting an interface list changed event
 168 */
 169 typedef void (*InterfaceListChangedCallback)(mDNS * const inMDNS);
 170 //---------------------------------------------------------------------------------------------------------------------------
 171
 172
 173 //---------------------------------------------------------------------------------------------------------------------------
 174 /*!     @typedef        HostDescriptionChangedCallback
 175
 176         @abstract       mDNSWin32 core will call out through this function pointer
 177                                 after detecting that the computer description has changed
 178 */
 179 typedef void (*HostDescriptionChangedCallback)(mDNS * const inMDNS);
 180 //---------------------------------------------------------------------------------------------------------------------------
 181
 182
 183 //---------------------------------------------------------------------------------------------------------------------------
 184 /*!     @struct         mDNS_PlatformSupport_struct
 185
 186         @abstract       Structure containing platform-specific data.
 187 */
 188
 189 struct  mDNS_PlatformSupport_struct
 190 {
 191         CRITICAL_SECTION                        lock;
 192         mDNSBool                                        lockInitialized;
 193         HANDLE                                          cancelEvent;
 194         HANDLE                                          quitEvent;
 195         HANDLE                                          interfaceListChangedEvent;
 196         HANDLE                                          descChangedEvent;       // Computer description changed event
 197         HANDLE                                          tcpipChangedEvent;      // TCP/IP config changed
 198         HANDLE                                          ddnsChangedEvent;       // DynDNS config changed
 199         HANDLE                                          wakeupEvent;
 200         HANDLE                                          initEvent;
 201         HKEY                                            descKey;
 202         HKEY                                            tcpipKey;
 203         HKEY                                            ddnsKey;
 204         mStatus                                         initStatus;
 205         mDNSBool                                        registeredLoopback4;
 206         SocketRef                                       interfaceListChangedSocket;
 207         int                                                     interfaceCount;
 208         mDNSInterfaceData *                     interfaceList;
 209         mDNSInterfaceData *                     inactiveInterfaceList;
 210         DWORD                                           threadID;
 211         IdleThreadCallback                      idleThreadCallback;
 212         InterfaceListChangedCallback    interfaceListChangedCallback;
 213         HostDescriptionChangedCallback  hostDescriptionChangedCallback;
 214         SocketRef                                               unicastSock4;
 215         HANDLE                                                  unicastSock4ReadEvent;
 216         mDNSAddr                                                unicastSock4DestAddr;
 217 #if( !defined( _WIN32_WCE ) )
 218         LPFN_WSARECVMSG                                 unicastSock4RecvMsgPtr;
 219 #endif
 220         SocketRef                                               unicastSock6;
 221         HANDLE                                                  unicastSock6ReadEvent;
 222         mDNSAddr                                                unicastSock6DestAddr;
 223 #if( !defined( _WIN32_WCE ) )
 224         LPFN_WSARECVMSG                                 unicastSock6RecvMsgPtr;
 225 #endif
 226 };
 227
 228 //---------------------------------------------------------------------------------------------------------------------------
 229 /*!     @struct         ifaddrs
 230
 231         @abstract       Interface information
 232 */
 233
 234 struct ifaddrs
 235 {
 236         struct ifaddrs *        ifa_next;
 237         char *                          ifa_name;
 238         u_int                           ifa_flags;
 239         struct sockaddr *       ifa_addr;
 240         struct sockaddr *       ifa_netmask;
 241         struct sockaddr *       ifa_broadaddr;
 242         struct sockaddr *       ifa_dstaddr;
 243         void *                          ifa_data;
 244
 245         struct
 246         {
 247                 uint32_t                index;
 248
 249         }       ifa_extra;
 250 };
 251
 252
 253 //---------------------------------------------------------------------------------------------------------------------------
 254 /*!     @function       GetWindowsVersionString
 255
 256         @abstract       Stores Windows version information in the string passed in (inBuffer)
 257 */
 258
 259 OSStatus        GetWindowsVersionString( char *inBuffer, size_t inBufferSize );
 260
 261
 262 //---------------------------------------------------------------------------------------------------------------------------
 263 /*!     @function       getifaddrs
 264
 265         @abstract       Builds a linked list of interfaces. Caller must free using freeifaddrs if successful.
 266 */
 267
 268 int     getifaddrs( struct ifaddrs **outAddrs );
 269
 270 //---------------------------------------------------------------------------------------------------------------------------
 271 /*!     @function       freeifaddrs
 272
 273         @abstract       Frees a linked list of interfaces built with getifaddrs.
 274 */
 275
 276 void    freeifaddrs( struct ifaddrs *inAddrs );
 277
 278
 279 #ifdef  __cplusplus
 280         }
 281 #endif
 282
 283 #endif  // __MDNS_WIN32__