1 | /* -*- Mode: C; tab-width: 4 -*- |
---|
2 | * |
---|
3 | * Copyright (c) 2003-2004, Apple Computer, Inc. All rights reserved. |
---|
4 | * |
---|
5 | * Redistribution and use in source and binary forms, with or without |
---|
6 | * modification, are permitted provided that the following conditions are met: |
---|
7 | * |
---|
8 | * 1. Redistributions of source code must retain the above copyright notice, |
---|
9 | * this list of conditions and the following disclaimer. |
---|
10 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
---|
11 | * this list of conditions and the following disclaimer in the documentation |
---|
12 | * and/or other materials provided with the distribution. |
---|
13 | * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of its |
---|
14 | * contributors may be used to endorse or promote products derived from this |
---|
15 | * software without specific prior written permission. |
---|
16 | * |
---|
17 | * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY |
---|
18 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
---|
19 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
---|
20 | * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY |
---|
21 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
---|
22 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
---|
23 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
---|
24 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
---|
26 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
27 | */ |
---|
28 | |
---|
29 | #ifndef DNSSD_IPC_H |
---|
30 | #define DNSSD_IPC_H |
---|
31 | |
---|
32 | #include "dns_sd.h" |
---|
33 | |
---|
34 | // |
---|
35 | // Common cross platform services |
---|
36 | // |
---|
37 | #if defined(WIN32) |
---|
38 | # include <winsock2.h> |
---|
39 | # define dnssd_InvalidSocket INVALID_SOCKET |
---|
40 | # define dnssd_SocketValid(s) ((s) != INVALID_SOCKET) |
---|
41 | # define dnssd_EWOULDBLOCK WSAEWOULDBLOCK |
---|
42 | # define dnssd_EINTR WSAEINTR |
---|
43 | # define dnssd_ECONNRESET WSAECONNRESET |
---|
44 | # define dnssd_sock_t SOCKET |
---|
45 | # define dnssd_socklen_t int |
---|
46 | # define dnssd_close(sock) closesocket(sock) |
---|
47 | # define dnssd_errno WSAGetLastError() |
---|
48 | # define dnssd_strerror(X) win32_strerror(X) |
---|
49 | # define ssize_t int |
---|
50 | # define getpid _getpid |
---|
51 | # define unlink _unlink |
---|
52 | extern char *win32_strerror(int inErrorCode); |
---|
53 | #else |
---|
54 | # include <sys/types.h> |
---|
55 | # include <unistd.h> |
---|
56 | # include <sys/un.h> |
---|
57 | # include <string.h> |
---|
58 | # include <stdio.h> |
---|
59 | # include <stdlib.h> |
---|
60 | # include <sys/stat.h> |
---|
61 | # include <sys/socket.h> |
---|
62 | # include <netinet/in.h> |
---|
63 | # include <arpa/inet.h> |
---|
64 | # define dnssd_InvalidSocket -1 |
---|
65 | # define dnssd_SocketValid(s) ((s) >= 0) |
---|
66 | # define dnssd_EWOULDBLOCK EWOULDBLOCK |
---|
67 | # define dnssd_EINTR EINTR |
---|
68 | # define dnssd_ECONNRESET ECONNRESET |
---|
69 | # define dnssd_EPIPE EPIPE |
---|
70 | # define dnssd_sock_t int |
---|
71 | # define dnssd_socklen_t unsigned int |
---|
72 | # define dnssd_close(sock) close(sock) |
---|
73 | # define dnssd_errno errno |
---|
74 | # define dnssd_strerror(X) strerror(X) |
---|
75 | #endif |
---|
76 | |
---|
77 | #if defined(USE_TCP_LOOPBACK) |
---|
78 | # define AF_DNSSD AF_INET |
---|
79 | # define MDNS_TCP_SERVERADDR "127.0.0.1" |
---|
80 | # define MDNS_TCP_SERVERPORT 5354 |
---|
81 | # define LISTENQ 5 |
---|
82 | # define dnssd_sockaddr_t struct sockaddr_in |
---|
83 | #else |
---|
84 | # define AF_DNSSD AF_LOCAL |
---|
85 | # ifndef MDNS_UDS_SERVERPATH |
---|
86 | # define MDNS_UDS_SERVERPATH "/var/run/mDNSResponder" |
---|
87 | # endif |
---|
88 | # define LISTENQ 100 |
---|
89 | // longest legal control path length |
---|
90 | # define MAX_CTLPATH 256 |
---|
91 | # define dnssd_sockaddr_t struct sockaddr_un |
---|
92 | #endif |
---|
93 | |
---|
94 | // Compatibility workaround |
---|
95 | #ifndef AF_LOCAL |
---|
96 | #define AF_LOCAL AF_UNIX |
---|
97 | #endif |
---|
98 | |
---|
99 | // General UDS constants |
---|
100 | #define TXT_RECORD_INDEX ((uint32_t)(-1)) // record index for default text record |
---|
101 | |
---|
102 | // IPC data encoding constants and types |
---|
103 | #define VERSION 1 |
---|
104 | #define IPC_FLAGS_NOREPLY 1 // set flag if no asynchronous replies are to be sent to client |
---|
105 | |
---|
106 | // Structure packing macro. If we're not using GNUC, it's not fatal. Most compilers naturally pack the on-the-wire |
---|
107 | // structures correctly anyway, so a plain "struct" is usually fine. In the event that structures are not packed |
---|
108 | // correctly, our compile-time assertion checks will catch it and prevent inadvertent generation of non-working code. |
---|
109 | #ifndef packedstruct |
---|
110 | #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9))) |
---|
111 | #define packedstruct struct __attribute__((__packed__)) |
---|
112 | #define packedunion union __attribute__((__packed__)) |
---|
113 | #else |
---|
114 | #define packedstruct struct |
---|
115 | #define packedunion union |
---|
116 | #endif |
---|
117 | #endif |
---|
118 | |
---|
119 | typedef enum |
---|
120 | { |
---|
121 | request_op_none = 0, // No request yet received on this connection |
---|
122 | connection_request = 1, // connected socket via DNSServiceConnect() |
---|
123 | reg_record_request, // reg/remove record only valid for connected sockets |
---|
124 | remove_record_request, |
---|
125 | enumeration_request, |
---|
126 | reg_service_request, |
---|
127 | browse_request, |
---|
128 | resolve_request, |
---|
129 | query_request, |
---|
130 | reconfirm_record_request, |
---|
131 | add_record_request, |
---|
132 | update_record_request, |
---|
133 | setdomain_request, // Up to here is in Tiger and B4W 1.0.3 |
---|
134 | getproperty_request, // New in B4W 1.0.4 |
---|
135 | port_mapping_request, // New in Leopard and B4W 2.0 |
---|
136 | addrinfo_request, |
---|
137 | send_bpf, // New in SL |
---|
138 | getpid_request, |
---|
139 | release_request, |
---|
140 | connection_delegate_request, |
---|
141 | |
---|
142 | cancel_request = 63 |
---|
143 | } request_op_t; |
---|
144 | |
---|
145 | typedef enum |
---|
146 | { |
---|
147 | enumeration_reply_op = 64, |
---|
148 | reg_service_reply_op, |
---|
149 | browse_reply_op, |
---|
150 | resolve_reply_op, |
---|
151 | query_reply_op, |
---|
152 | reg_record_reply_op, // Up to here is in Tiger and B4W 1.0.3 |
---|
153 | getproperty_reply_op, // New in B4W 1.0.4 |
---|
154 | port_mapping_reply_op, // New in Leopard and B4W 2.0 |
---|
155 | addrinfo_reply_op |
---|
156 | } reply_op_t; |
---|
157 | |
---|
158 | #if defined(_WIN64) |
---|
159 | # pragma pack(push,4) |
---|
160 | #endif |
---|
161 | |
---|
162 | // Define context object big enough to hold a 64-bit pointer, |
---|
163 | // to accomodate 64-bit clients communicating with 32-bit daemon. |
---|
164 | // There's no reason for the daemon to ever be a 64-bit process, but its clients might be |
---|
165 | typedef packedunion |
---|
166 | { |
---|
167 | void *context; |
---|
168 | uint32_t u32[2]; |
---|
169 | } client_context_t; |
---|
170 | |
---|
171 | typedef packedstruct |
---|
172 | { |
---|
173 | uint32_t version; |
---|
174 | uint32_t datalen; |
---|
175 | uint32_t ipc_flags; |
---|
176 | uint32_t op; // request_op_t or reply_op_t |
---|
177 | client_context_t client_context; // context passed from client, returned by server in corresponding reply |
---|
178 | uint32_t reg_index; // identifier for a record registered via DNSServiceRegisterRecord() on a |
---|
179 | // socket connected by DNSServiceCreateConnection(). Must be unique in the scope of the connection, such that and |
---|
180 | // index/socket pair uniquely identifies a record. (Used to select records for removal by DNSServiceRemoveRecord()) |
---|
181 | } ipc_msg_hdr; |
---|
182 | |
---|
183 | #if defined(_WIN64) |
---|
184 | # pragma pack(pop) |
---|
185 | #endif |
---|
186 | |
---|
187 | // routines to write to and extract data from message buffers. |
---|
188 | // caller responsible for bounds checking. |
---|
189 | // ptr is the address of the pointer to the start of the field. |
---|
190 | // it is advanced to point to the next field, or the end of the message |
---|
191 | |
---|
192 | void put_uint32(const uint32_t l, char **ptr); |
---|
193 | uint32_t get_uint32(const char **ptr, const char *end); |
---|
194 | |
---|
195 | void put_uint16(uint16_t s, char **ptr); |
---|
196 | uint16_t get_uint16(const char **ptr, const char *end); |
---|
197 | |
---|
198 | #define put_flags put_uint32 |
---|
199 | #define get_flags get_uint32 |
---|
200 | |
---|
201 | #define put_error_code put_uint32 |
---|
202 | #define get_error_code get_uint32 |
---|
203 | |
---|
204 | int put_string(const char *str, char **ptr); |
---|
205 | int get_string(const char **ptr, const char *const end, char *buffer, int buflen); |
---|
206 | |
---|
207 | void put_rdata(const int rdlen, const unsigned char *rdata, char **ptr); |
---|
208 | const char *get_rdata(const char **ptr, const char *end, int rdlen); // return value is rdata pointed to by *ptr - |
---|
209 | // rdata is not copied from buffer. |
---|
210 | |
---|
211 | void ConvertHeaderBytes(ipc_msg_hdr *hdr); |
---|
212 | |
---|
213 | struct CompileTimeAssertionChecks_dnssd_ipc |
---|
214 | { |
---|
215 | // Check that the compiler generated our on-the-wire packet format structure definitions |
---|
216 | // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries. |
---|
217 | char assert0[(sizeof(client_context_t) == 8) ? 1 : -1]; |
---|
218 | char assert1[(sizeof(ipc_msg_hdr) == 28) ? 1 : -1]; |
---|
219 | }; |
---|
220 | |
---|
221 | #endif // DNSSD_IPC_H |
---|