summaryrefslogtreecommitdiff
path: root/data/libresolv/dnsinfo_private.h
diff options
context:
space:
mode:
Diffstat (limited to 'data/libresolv/dnsinfo_private.h')
-rw-r--r--data/libresolv/dnsinfo_private.h193
1 files changed, 193 insertions, 0 deletions
diff --git a/data/libresolv/dnsinfo_private.h b/data/libresolv/dnsinfo_private.h
new file mode 100644
index 000000000..5e6ac0e5a
--- /dev/null
+++ b/data/libresolv/dnsinfo_private.h
@@ -0,0 +1,193 @@
+/*
+ * Copyright (c) 2004, 2005 Apple Computer, Inc. All rights reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+#ifndef __DNSINFO_PRIVATE_H__
+#define __DNSINFO_PRIVATE_H__
+
+
+#include <AvailabilityMacros.h>
+#include <sys/cdefs.h>
+#include <stdint.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <mach/mach.h>
+
+#include "dnsinfo.h"
+
+#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1040
+
+/*
+ * What's all of this stuff about???
+ *
+ * In order to minimize the amount of data conversions associated with
+ * storing, retrieving, and accessing the systems DNS configuration I
+ * have opted to create a memory image filled with the actual data
+ * types / structures that would be used by those applications which
+ * make use of these APIS. The implication here is that we use
+ * sockaddr's for addresses, char *'s for strings, etc.
+ *
+ * To achieve this goal the APIs which are used to store and access the
+ * configuration data build and use a single buffer of the relevant
+ * bits. When multiple instances of a given type / structure are needed
+ * we maintain a count, the actual data, and when the configuration has
+ * been unpacked, arrays of pointers to the data.
+ *
+ * In memory, the data looks as follows:
+ *
+ * +-------------------------------------------------------------------+
+ * | struct _dns_config_buf_t |
+ * +-+-------------+---------------------------------------------------+
+ * | | config | struct dns_config_t |
+ * | | +-+--------------+----------------------------------+
+ * | | | | n_resolver | int32_t | <- # of name resolvers
+ * | | | +--------------+----------------------------------+
+ * | | | | resolver | dns_resolver_t ** | <- not used during creation, filled
+ * | | | | | | in with pointer to a list of
+ * | | | | | | resolver configurations which be
+ * | | | | | | established in the "padding"
+ * | | | +--------------+----------------------------------+
+ * | | | | ... | ... |
+ * | +-------------+-+--------------+----------------------------------+
+ * | | n_attribute | uint32_t | <- how many bytes of "attribute"
+ * | | | | data is associated with the
+ * | | | | configuration
+ * |-+-------------+---------------------------------------------------+
+ * | | n_padding | uint32_t | <- how many additional bytes
+ * | | | | for arrays (of pointers), ...
+ * +-+-------------+---------------------------------------------------+
+ * | struct dns_attribute_t |
+ * |-+-------------+---------------------------------------------------+
+ * | | type | uint32_t | <- type of attribute (e.g. CONFIG_ATTRIBUTE_RESOLVER)
+ * | +-------------+---------------------------------------------------+
+ * | | length | uint32_t | <- length of the attribute
+ * | +-------------+---------------------------------------------------+
+ * | | attribute | struct _dns_resolver_buf_t | <- the attribute data (resolver configuration #1)
+ * | | +-+-------------+-----------------------------------+
+ * | | | | resolver | struct dns_resolver_t |
+ * | | | | +--------------+--------------------+
+ * | | | | | domain | char * | <- not used during creation,
+ * | | | | | | | filled in with pointer to
+ * | | | | | | | domain name in the "padding"
+ * | | | | +--------------+--------------------+
+ * | | | | | n_nameserver | int32_t | <- # of name server addresses
+ * | | | | +--------------+--------------------+
+ * | | | | | nameserver | struct sockaddr ** | <- not used during creation,
+ * | | | | | | | filled in with pointer to
+ * | | | | | | | a list of addresses which
+ * | | | | | | | will be established in the
+ * | | | | | | | "padding"
+ * | | | | +--------------+--------------------+
+ * | | | | | ... |
+ * | | +-+-------------+--------------+--------------------+
+ * | | | | n_attribute | uint32_t |
+ * | | +-+-------------+-----------------------------------+
+ * | | | | attribute | struct dns_attribute_t |
+ * | | | | +-+-----------+---------------------+
+ * | | | | | | type | uint32_t | <- type of attribute (e.g. RESOLVER_ATTRIBUTE_DOMAIN)
+ * | | | | | +-----------+---------------------+
+ * | | | | | | length | uint32_t | <- length of the attribute
+ * | | | | | +-----------+---------------------+
+ * | | | | | | attribute | | <- the attribute data ("apple.com")
+ * | | +-+-------------+-------------+---------------------+
+ * | | | | attribute | struct dns_attribute_t |
+ * | | | | +-+-----------+---------------------+
+ * | | | | | | type | uint32_t | <- type of attribute (e.g. RESOLVER_ATTRIBUTE_ADDRESS)
+ * | | | | | +-----------+---------------------+
+ * | | | | | | length | uint32_t | <- length of the attribute
+ * | | | | | +-----------+---------------------+
+ * | | | | | | attribute | | <- the attribute data ("struct sockaddr_in" #1)
+ * | | +---------------+-----------------------------------+
+ * | | | | attribute | struct dns_attribute_t |
+ * | | | | +-+-----------+---------------------+
+ * | | | | | | type | uint32_t | <- type of attribute (e.g. RESOLVER_ATTRIBUTE_ADDRESS)
+ * | | | | | +-----------+---------------------+
+ * | | | | | | length | uint32_t | <- length of the attribute
+ * | | | | | +-----------+---------------------+
+ * | | | | | | attribute | | <- the attribute data ("struct sockaddr_in" #2)
+ * | | +---------------+-----------------------------------+
+ * | | | ... |
+ * +-+-------------+---------------------------------------------------+
+ * | | attribute | struct _dns_resolver_buf_t | <- the attribute data (resolver configuration #2)
+ * | | +---------------+-----------------------------------+
+ * | | | ... |
+ * +---------------+---------------------------------------------------+
+ * | | ... |
+ * +---------------+---------------------------------------------------+
+ *
+ * When the data is unpacked the "n_padding" additional bytes
+ * specified in configuration buffer will be allocated at the
+ * end of this buffer. Arrays of pointers will be allocated
+ * within the extra space array element (an "attribute") is
+ * encountered the pointer reference will be filled in.
+ */
+
+
+// configuration buffer attributes
+enum {
+ CONFIG_ATTRIBUTE_RESOLVER = 1
+};
+
+
+// resolver buffer attributes
+enum {
+ RESOLVER_ATTRIBUTE_DOMAIN = 10,
+ RESOLVER_ATTRIBUTE_ADDRESS,
+ RESOLVER_ATTRIBUTE_SEARCH,
+ RESOLVER_ATTRIBUTE_SORTADDR,
+ RESOLVER_ATTRIBUTE_OPTIONS
+};
+
+
+typedef struct {
+ uint32_t type;
+ uint32_t length;
+ uint8_t attribute[0];
+} dns_attribute_t;
+
+
+typedef struct {
+ dns_config_t config;
+ uint32_t n_attribute;
+ uint32_t n_padding;
+ uint8_t attribute[0];
+} _dns_config_buf_t;
+
+
+typedef struct {
+ dns_resolver_t resolver;
+ uint32_t n_attribute;
+ uint8_t attribute[0];
+} _dns_resolver_buf_t;
+
+
+__BEGIN_DECLS
+
+const char * _dns_configuration_notify_key() AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
+mach_port_t _dns_configuration_server_port() AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
+
+__END_DECLS
+
+#endif /* MAC_OS_X_VERSION_MAX_ALLOWED >= 1040 */
+
+#endif /* __DNSINFO_PRIVATE_H__ */
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-08 14:49:48 +0000