dnssd_ipc.h revision 5ffb0c9b03b5149ff4f5821a62be4a52408ada2a
4b22b9337f359bfd063322244f5336cc7c6ffcfars/* -*- Mode: C; tab-width: 4 -*-
4b22b9337f359bfd063322244f5336cc7c6ffcfars * Copyright (c) 2003-2004, Apple Computer, Inc. All rights reserved.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * Redistribution and use in source and binary forms, with or without
4b22b9337f359bfd063322244f5336cc7c6ffcfars * modification, are permitted provided that the following conditions are met:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * 1. Redistributions of source code must retain the above copyright notice,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * this list of conditions and the following disclaimer.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * 2. Redistributions in binary form must reproduce the above copyright notice,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * this list of conditions and the following disclaimer in the documentation
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * and/or other materials provided with the distribution.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of its
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * contributors may be used to endorse or promote products derived from this
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * software without specific prior written permission.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
4b22b9337f359bfd063322244f5336cc7c6ffcfars * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Common cross platform services
4b22b9337f359bfd063322244f5336cc7c6ffcfars#if defined(WIN32)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome# define dnssd_SocketValid(s) ((s) != INVALID_SOCKET)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome# define dnssd_SocketValid(s) ((s) >= 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome# define dnssd_socklen_t unsigned int
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome# define MDNS_UDS_SERVERPATH "/var/run/mDNSResponder"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome# define MDNS_UDS_SERVERPATH_ENVVAR "DNSSD_UDS_PATH"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// longest legal control path length
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Compatibility workaround
4b22b9337f359bfd063322244f5336cc7c6ffcfars// General UDS constants
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TXT_RECORD_INDEX ((uint32_t)(-1)) // record index for default text record
4b22b9337f359bfd063322244f5336cc7c6ffcfars// IPC data encoding constants and types
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define IPC_FLAGS_NOREPLY 1 // set flag if no asynchronous replies are to be sent to client
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Structure packing macro. If we're not using GNUC, it's not fatal. Most compilers naturally pack the on-the-wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// structures correctly anyway, so a plain "struct" is usually fine. In the event that structures are not packed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// correctly, our compile-time assertion checks will catch it and prevent inadvertent generation of non-working code.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome #define packedstruct struct __attribute__((__packed__))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome #define packedunion union __attribute__((__packed__))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome #define packedstruct struct
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef enum
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome request_op_none = 0, // No request yet received on this connection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome connection_request = 1, // connected socket via DNSServiceConnect()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome reg_record_request, // reg/remove record only valid for connected sockets
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome setdomain_request, // Up to here is in Tiger and B4W 1.0.3
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome port_mapping_request, // New in Leopard and B4W 2.0
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef enum
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome reg_record_reply_op, // Up to here is in Tiger and B4W 1.0.3
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome port_mapping_reply_op, // New in Leopard and B4W 2.0
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Define context object big enough to hold a 64-bit pointer,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// to accomodate 64-bit clients communicating with 32-bit daemon.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// There's no reason for the daemon to ever be a 64-bit process, but its clients might be
4b22b9337f359bfd063322244f5336cc7c6ffcfars client_context_t client_context; // context passed from client, returned by server in corresponding reply
4b22b9337f359bfd063322244f5336cc7c6ffcfars uint32_t reg_index; // identifier for a record registered via DNSServiceRegisterRecord() on a
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // socket connected by DNSServiceCreateConnection(). Must be unique in the scope of the connection, such that and
4b22b9337f359bfd063322244f5336cc7c6ffcfars // index/socket pair uniquely identifies a record. (Used to select records for removal by DNSServiceRemoveRecord())
4b22b9337f359bfd063322244f5336cc7c6ffcfars// routines to write to and extract data from message buffers.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// caller responsible for bounds checking.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ptr is the address of the pointer to the start of the field.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// it is advanced to point to the next field, or the end of the message
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeuint32_t get_uint32(const char **ptr, const char *end);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeuint16_t get_uint16(const char **ptr, const char *end);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeint get_string(const char **ptr, const char *const end, char *buffer, int buflen);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsvoid put_rdata(const int rdlen, const unsigned char *rdata, char **ptr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeconst char *get_rdata(const char **ptr, const char *end, int rdlen); // return value is rdata pointed to by *ptr -
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// rdata is not copied from buffer.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Check that the compiler generated our on-the-wire packet format structure definitions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert0[(sizeof(client_context_t) == 8) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert1[(sizeof(ipc_msg_hdr) == 28) ? 1 : -1];
4b22b9337f359bfd063322244f5336cc7c6ffcfars#endif // DNSSD_IPC_H