mDNSResponder-765.30.11.tar.gz

[apple/mdnsresponder.git] / mDNSShared / dnssd_ipc.h

diff --git a/mDNSShared/dnssd_ipc.h b/mDNSShared/dnssd_ipc.h
index 32d7872e1c420ef71f4b427acd3c2fdb439514ce..96466a944c6e0815a11ef9719082c5e5f33876ce 100644 (file)
--- a/mDNSShared/dnssd_ipc.h
+++ b/mDNSShared/dnssd_ipc.h
@@ -1,82 +1,29 @@
-/*
- * Copyright (c) 2003-2004, Apple Computer, Inc. All rights reserved.
+/* -*- Mode: C; tab-width: 4 -*-

  *
  *

- * Redistribution and use in source and binary forms, with or without 
+ * Copyright (c) 2003-2015 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without

  * modification, are permitted provided that the following conditions are met:
  *
  * modification, are permitted provided that the following conditions are met:
  *

- * 1.  Redistributions of source code must retain the above copyright notice, 
- *     this list of conditions and the following disclaimer. 
- * 2.  Redistributions in binary form must reproduce the above copyright notice, 
- *     this list of conditions and the following disclaimer in the documentation 
- *     and/or other materials provided with the distribution. 
- * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of its 
- *     contributors may be used to endorse or promote products derived from this 
- *     software without specific prior written permission. 
+ * 1.  Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ * 2.  Redistributions in binary form must reproduce the above copyright notice,
+ *     this list of conditions and the following disclaimer in the documentation
+ *     and/or other materials provided with the distribution.
+ * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
+ *     contributors may be used to endorse or promote products derived from this
+ *     software without specific prior written permission.

  *
  *

- * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
- * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-
-    Change History (most recent first):
-
-$Log: dnssd_ipc.h,v $
-Revision 1.21  2005/09/29 06:38:13  herscher
-Remove #define MSG_WAITALL on Windows.  We don't use this macro anymore, and it's presence causes warnings to be emitted when compiling against the latest Microsoft Platform SDK.
-
-Revision 1.20  2005/03/21 00:39:31  shersche
-<rdar://problem/4021486> Fix build warnings on Win32 platform
-
-Revision 1.19  2005/02/02 02:25:22  cheshire
-<rdar://problem/3980388> /var/run/mDNSResponder should be /var/run/mdnsd on Linux
-
-Revision 1.18  2005/01/27 22:57:56  cheshire
-Fix compile errors on gcc4
-
-Revision 1.17  2004/11/23 03:39:47  cheshire
-Let interface name/index mapping capability live directly in JNISupport.c,
-instead of having to call through to the daemon via IPC to get this information.
-
-Revision 1.16  2004/11/12 03:21:41  rpantos
-rdar://problem/3809541 Add DNSSDMapIfIndexToName, DNSSDMapNameToIfIndex.
-
-Revision 1.15  2004/10/06 02:22:20  cheshire
-Changed MacRoman copyright symbol (should have been UTF-8 in any case :-) to ASCII-compatible "(c)"
-
-Revision 1.14  2004/10/01 22:15:55  rpantos
-rdar://problem/3824265: Replace APSL in client lib with BSD license.
-
-Revision 1.13  2004/09/16 23:14:25  cheshire
-Changes for Windows compatibility
-
-Revision 1.12  2004/09/16 21:46:38  ksekar
-<rdar://problem/3665304> Need SPI for LoginWindow to associate a UID with a Wide Area domain
-
-Revision 1.11  2004/08/10 06:24:56  cheshire
-Use types with precisely defined sizes for 'op' and 'reg_index', for better
-compatibility if the daemon and the client stub are built using different compilers
-
-Revision 1.10  2004/07/07 17:39:25  shersche
-Change MDNS_SERVERPORT from 5533 to 5354.
-
-Revision 1.9  2004/06/25 00:26:27  rpantos
-Changes to fix the Posix build on Solaris.
-
-Revision 1.8  2004/06/18 04:56:51  rpantos
-Add layer for platform code
-
-Revision 1.7  2004/06/12 01:08:14  cheshire
-Changes for Windows compatibility
-
-Revision 1.6  2003/08/12 19:56:25  cheshire
-Update to APSL 2.0
-

  */
 
 #ifndef DNSSD_IPC_H
  */
 
 #ifndef DNSSD_IPC_H


@@ -84,81 +31,95 @@ Update to APSL 2.0
 
 #include "dns_sd.h"
 
 
 #include "dns_sd.h"
 

-

 //
 // Common cross platform services
 //
 #if defined(WIN32)
 //
 // Common cross platform services
 //
 #if defined(WIN32)

-#      include <winsock2.h>
-#      define dnssd_InvalidSocket      INVALID_SOCKET
-#      define dnssd_EWOULDBLOCK        WSAEWOULDBLOCK
-#      define dnssd_EINTR                      WSAEINTR
-#      define dnssd_sock_t                     SOCKET
-#      define dnssd_socklen_t          int
-#      define dnssd_sockbuf_t          const char*
-#      define dnssd_close(sock)        closesocket(sock)
-#      define dnssd_errno()            WSAGetLastError()
-#      define ssize_t                          int
-#      define getpid                           _getpid
+#   include <winsock2.h>
+#   define dnssd_InvalidSocket  INVALID_SOCKET
+#   define dnssd_SocketValid(s) ((s) != INVALID_SOCKET)
+#   define dnssd_EWOULDBLOCK    WSAEWOULDBLOCK
+#   define dnssd_EINTR          WSAEINTR
+#   define dnssd_ECONNRESET     WSAECONNRESET
+#   define dnssd_socklen_t      int
+#   define dnssd_close(sock)    closesocket(sock)
+#   define dnssd_errno          WSAGetLastError()
+#   define dnssd_strerror(X)    win32_strerror(X)
+#   define ssize_t              int
+#   define getpid               _getpid
+#   define unlink               _unlink
+extern char *win32_strerror(int inErrorCode);

 #else
 #else

-#      include <sys/types.h>
-#      include <unistd.h>
-#      include <sys/un.h>
-#      include <string.h>
-#      include <stdio.h>
-#      include <stdlib.h>
-#      include <sys/stat.h>
-#      include <sys/socket.h>
-#      include <netinet/in.h>
-#      define dnssd_InvalidSocket      -1
-#      define dnssd_EWOULDBLOCK        EWOULDBLOCK
-#      define dnssd_EINTR                      EINTR
-#      define dnssd_EPIPE                      EPIPE
-#      define dnssd_sock_t                     int
-#      define dnssd_socklen_t          unsigned int
-#      define dnssd_sockbuf_t          const char*
-#      define dnssd_close(sock)        close(sock)
-#      define dnssd_errno()            errno
+#   include <sys/types.h>
+#   include <unistd.h>
+#   include <sys/un.h>
+#   include <string.h>
+#   include <stdio.h>
+#   include <stdlib.h>
+#   include <sys/stat.h>
+#   include <sys/socket.h>
+#   include <netinet/in.h>
+#   include <arpa/inet.h>
+#   define dnssd_InvalidSocket  -1
+#   define dnssd_SocketValid(s) ((s) >= 0)
+#   define dnssd_EWOULDBLOCK    EWOULDBLOCK
+#   define dnssd_EINTR          EINTR
+#   define dnssd_ECONNRESET     ECONNRESET
+#   define dnssd_EPIPE          EPIPE
+#   define dnssd_socklen_t      unsigned int
+#   define dnssd_close(sock)    close(sock)
+#   define dnssd_errno          errno
+#   define dnssd_strerror(X)    strerror(X)

 #endif
 
 #if defined(USE_TCP_LOOPBACK)
 #endif
 
 #if defined(USE_TCP_LOOPBACK)

-#      define AF_DNSSD                         AF_INET
-#      define MDNS_TCP_SERVERADDR      "127.0.0.1"
-#      define MDNS_TCP_SERVERPORT      5354
-#      define LISTENQ                          5
-#      define dnssd_sockaddr_t         struct sockaddr_in
+#   define AF_DNSSD             AF_INET
+#   define MDNS_TCP_SERVERADDR  "127.0.0.1"
+#   define MDNS_TCP_SERVERPORT  5354
+#   define LISTENQ              5
+#   define dnssd_sockaddr_t     struct sockaddr_in

 #else
 #else

-#      define AF_DNSSD                         AF_LOCAL
-#      ifndef MDNS_UDS_SERVERPATH
-#              define MDNS_UDS_SERVERPATH      "/var/run/mDNSResponder"
-#      endif
-#      define LISTENQ                          100
-    // longest legal control path length
-#      define MAX_CTLPATH                      256     
-#      define dnssd_sockaddr_t         struct sockaddr_un
+#   define AF_DNSSD             AF_LOCAL
+#   ifndef MDNS_UDS_SERVERPATH
+#       define MDNS_UDS_SERVERPATH  "/var/run/mDNSResponder"
+#   endif
+#   define MDNS_UDS_SERVERPATH_ENVVAR "DNSSD_UDS_PATH"
+#   define LISTENQ              100
+// longest legal control path length
+#   define MAX_CTLPATH          (sizeof(((struct sockaddr_un*)0)->sun_path))
+#   define dnssd_sockaddr_t     struct sockaddr_un

 #endif
 
 #endif
 

-
-//#define UDSDEBUG  // verbose debug output
-

 // Compatibility workaround
 #ifndef AF_LOCAL
 // Compatibility workaround
 #ifndef AF_LOCAL

-#define        AF_LOCAL        AF_UNIX
+#define AF_LOCAL    AF_UNIX

 #endif
 
 // General UDS constants
 #endif
 
 // General UDS constants

-#define TXT_RECORD_INDEX ((uint32_t)(-1))      // record index for default text record
+#define TXT_RECORD_INDEX ((uint32_t)(-1))   // record index for default text record

 
 // IPC data encoding constants and types
 #define VERSION 1
 
 // IPC data encoding constants and types
 #define VERSION 1

-#define IPC_FLAGS_NOREPLY 1    // set flag if no asynchronous replies are to be sent to client
-#define IPC_FLAGS_REUSE_SOCKET 2 // set flag if synchronous errors are to be sent via the primary socket
-                                // (if not set, first string in message buffer must be path to error socket
+#define IPC_FLAGS_NOREPLY 1 // set flag if no asynchronous replies are to be sent to client
+
+// Structure packing macro. If we're not using GNUC, it's not fatal. Most compilers naturally pack the on-the-wire
+// structures correctly anyway, so a plain "struct" is usually fine. In the event that structures are not packed
+// correctly, our compile-time assertion checks will catch it and prevent inadvertent generation of non-working code.
+#ifndef packedstruct
+ #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
+  #define packedstruct struct __attribute__((__packed__))
+  #define packedunion  union  __attribute__((__packed__))
+ #else
+  #define packedstruct struct
+  #define packedunion  union
+ #endif
+#endif

 
 typedef enum
 
 typedef enum

-    {
-    connection = 1,           // connected socket via DNSServiceConnect()
-    reg_record_request,          // reg/remove record only valid for connected sockets
+{
+    request_op_none = 0,    // No request yet received on this connection
+    connection_request = 1, // connected socket via DNSServiceConnect()
+    reg_record_request,     // reg/remove record only valid for connected sockets

     remove_record_request,
     enumeration_request,
     reg_service_request,
     remove_record_request,
     enumeration_request,
     reg_service_request,


@@ -168,75 +129,92 @@ typedef enum
     reconfirm_record_request,
     add_record_request,
     update_record_request,
     reconfirm_record_request,
     add_record_request,
     update_record_request,

-    setdomain_request
-    } request_op_t;
+    setdomain_request,      // Up to here is in Tiger and B4W 1.0.3
+    getproperty_request,    // New in B4W 1.0.4
+    port_mapping_request,   // New in Leopard and B4W 2.0
+    addrinfo_request,
+    send_bpf,               // New in SL
+    getpid_request,
+    release_request,
+    connection_delegate_request,
+
+    cancel_request = 63
+} request_op_t;

 
 typedef enum
 
 typedef enum

-    {
-    enumeration_reply = 64,
-    reg_service_reply,
-    browse_reply,
-    resolve_reply,
-    query_reply,
-    reg_record_reply
-    } reply_op_t;
-
-typedef struct ipc_msg_hdr_struct ipc_msg_hdr;
-
-// client stub callback to process message from server and deliver results to
-// client application
-
-typedef void (*process_reply_callback)
-    (
-    DNSServiceRef sdr,
-    ipc_msg_hdr *hdr,
-    char *msg
-    );
-
-// allow 64-bit client to interoperate w/ 32-bit daemon
-typedef union
-    {
+{
+    enumeration_reply_op = 64,
+    reg_service_reply_op,
+    browse_reply_op,
+    resolve_reply_op,
+    query_reply_op,
+    reg_record_reply_op,    // Up to here is in Tiger and B4W 1.0.3
+    getproperty_reply_op,   // New in B4W 1.0.4
+    port_mapping_reply_op,  // New in Leopard and B4W 2.0
+    addrinfo_reply_op
+} reply_op_t;
+
+#if defined(_WIN64)
+#   pragma pack(push,4)
+#endif
+
+// Define context object big enough to hold a 64-bit pointer,
+// to accomodate 64-bit clients communicating with 32-bit daemon.
+// There's no reason for the daemon to ever be a 64-bit process, but its clients might be
+typedef packedunion
+{

     void *context;
     void *context;

-    uint32_t ptr64[2];
-    } client_context_t;
+    uint32_t u32[2];
+} client_context_t;

 
 

-typedef struct ipc_msg_hdr_struct
-    {
+typedef packedstruct
+{

     uint32_t version;
     uint32_t datalen;
     uint32_t version;
     uint32_t datalen;

-    uint32_t flags;
-    uint32_t op;               // request_op_t or reply_op_t
+    uint32_t ipc_flags;
+    uint32_t op;        // request_op_t or reply_op_t

     client_context_t client_context; // context passed from client, returned by server in corresponding reply
     uint32_t reg_index;            // identifier for a record registered via DNSServiceRegisterRecord() on a
     client_context_t client_context; // context passed from client, returned by server in corresponding reply
     uint32_t reg_index;            // identifier for a record registered via DNSServiceRegisterRecord() on a

-    // socket connected by DNSServiceConnect().  Must be unique in the scope of the connection, such that and
+    // socket connected by DNSServiceCreateConnection().  Must be unique in the scope of the connection, such that and

     // index/socket pair uniquely identifies a record.  (Used to select records for removal by DNSServiceRemoveRecord())
     // index/socket pair uniquely identifies a record.  (Used to select records for removal by DNSServiceRemoveRecord())

-    } ipc_msg_hdr_struct;
+} ipc_msg_hdr;
+
+#if defined(_WIN64)
+#   pragma pack(pop)
+#endif

 
 

-// it is advanced to point to the next field, or the end of the message

 // routines to write to and extract data from message buffers.
 // caller responsible for bounds checking.
 // ptr is the address of the pointer to the start of the field.
 // it is advanced to point to the next field, or the end of the message
 
 // routines to write to and extract data from message buffers.
 // caller responsible for bounds checking.
 // ptr is the address of the pointer to the start of the field.
 // it is advanced to point to the next field, or the end of the message
 

-void put_long(const uint32_t l, char **ptr);
-uint32_t get_long(char **ptr);
+void put_uint32(const uint32_t l, char **ptr);
+uint32_t get_uint32(const char **ptr, const char *end);

 
 

-void put_short(uint16_t s, char **ptr);
-uint16_t get_short(char **ptr);
+void put_uint16(uint16_t s, char **ptr);
+uint16_t get_uint16(const char **ptr, const char *end);

 
 

-#define put_flags put_long
-#define get_flags get_long
+#define put_flags put_uint32
+#define get_flags get_uint32

 
 

-#define put_error_code put_long
-#define get_error_code get_long
+#define put_error_code put_uint32
+#define get_error_code get_uint32

 
 int put_string(const char *str, char **ptr);
 
 int put_string(const char *str, char **ptr);

-int get_string(char **ptr, char *buffer, int buflen);
+int get_string(const char **ptr, const char *const end, char *buffer, int buflen);

 
 void put_rdata(const int rdlen, const unsigned char *rdata, char **ptr);
 
 void put_rdata(const int rdlen, const unsigned char *rdata, char **ptr);

-char *get_rdata(char **ptr, int rdlen);  // return value is rdata pointed to by *ptr -
-                                         // rdata is not copied from buffer.
+const char *get_rdata(const char **ptr, const char *end, int rdlen);  // return value is rdata pointed to by *ptr -
+// rdata is not copied from buffer.

 
 void ConvertHeaderBytes(ipc_msg_hdr *hdr);
 
 
 void ConvertHeaderBytes(ipc_msg_hdr *hdr);
 

+struct CompileTimeAssertionChecks_dnssd_ipc
+{
+    // Check that the compiler generated our on-the-wire packet format structure definitions
+    // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries.
+    char assert0[(sizeof(client_context_t) ==  8) ? 1 : -1];
+    char assert1[(sizeof(ipc_msg_hdr)      == 28) ? 1 : -1];
+};
+

 #endif // DNSSD_IPC_H
 #endif // DNSSD_IPC_H