osd-contiki/core/net/ip/resolv.h

107 lines
3.5 KiB
C
Raw Normal View History

/*
* Copyright (c) 2002-2003, Adam Dunkels.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* 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. The name of the author may not be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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.
*
* This file is part of the uIP TCP/IP stack.
*
*
*/
/**
* \file
* uIP DNS resolver code header file.
* \author Adam Dunkels <adam@dunkels.com>
*/
#ifndef RESOLV_H_
#define RESOLV_H_
#include "contiki.h"
core/net/resolv: IPv6 and mDNS ("Bonjour") support. Major refactor. This patch updates the DNS resolver to support IPv6 and introduces an improved API for looking up DNS entries. This patch also adds optional support for mDNS lookups and responses to the DNS resolver. Here is a quick summary of the changes: * Added support for IPv6 lookups. * DNS queries now honor record expiration. * Added support for mDNS, compatible with "Bonjour". * Implemented a new lookup api, `resolv_lookup2()`, which provides more information about the state of the record(error, expired, looking-up, etc.). About mDNS/Bonjour Support -------------------------- This patch adds basic support for mDNS/Bonjour, which allows you to refer to the name of a device instead of its IP address. This is incredibly convenient for IPv6 addresses because they tend to be very long and difficult to remember. It is especially important for link-local IPv6 addresses, since not all programs support the '%' notation for indicating a network interface (required on systems with more than one network interface to disambiguate). In other words, instead of typing in this: * `http://[fe80::58dc:d7ed:a644:628f%en1]/` You can type this instead: * `http://contiki.local/` Huge improvement, no? The convenience extends beyond that: this mechanism can be used for nodes to talk to each other based on their human-readable names instead of their IPv6 addresses. So instead of a switch on `aaaa::58dc:d7ed:a644:628f` triggering an actuator on `aaaa::ed26:19c1:4bd2:f95b`, `light-switch.local` can trigger the actuator on `living-room-lights.local`. What you need to do to be able to look up `.local` names on your workstation depends on a few factors: * Your machine needs to be able to send and receive multicast packets to and from the LoWPAN. You can do this easily with the Jackdaw firmware on an RZUSBStick. If you have a border router, you will need it to bridge the mDNS multicast packets across the border. * If you are using a Mac, you win. All Apple devices support mDNS lookups. * If you are using Windows, you can install Apple's Bonjour for Windows package. (This may be already installed on your machine if you have installed iTunes) After you install this you can easily do `.local` lookups. * If you are using a Unix machine, you can install Avahi. The default hostname is set to `contiki.local.`. You can change the hostname programmatically by calling `resolv_set_hostname()`. You can change the default hostname by changing `CONTIKI_CONF_DEFAULT_HOSTNAME`. You may disable mDNS support by setting `RESOLV_CONF_SUPPORTS_MDNS` to `0`. --------------------------------- core/net/resolv: `resolv_lookup2()` -> `resolv_lookup()` Note that this patch should fix several `resolv_lookup()` bugs that already existed. There were many cases where `resolv_lookup()` was being called and the IP address ignored, but later code assumed that the IP address had been fetched... ANYWAY, those should be fixed now. --------------------------------- examples/udp-ipv6: Updated client to use MDNS to lookup the server. Also updated the Cooja regression test simulation.
2012-05-17 17:24:08 +02:00
#include "uip.h"
/** If RESOLV_CONF_SUPPORTS_MDNS is set, then queries
* for domain names in the `local` TLD will use MDNS and
* will respond to MDNS queries for this device's hostname,
* as described by draft-cheshire-dnsext-multicastdns.
*/
#ifndef RESOLV_CONF_SUPPORTS_MDNS
#define RESOLV_CONF_SUPPORTS_MDNS (1)
#endif
/**
* Event that is broadcasted when a DNS name has been resolved.
*/
CCIF extern process_event_t resolv_event_found;
core/net/resolv: IPv6 and mDNS ("Bonjour") support. Major refactor. This patch updates the DNS resolver to support IPv6 and introduces an improved API for looking up DNS entries. This patch also adds optional support for mDNS lookups and responses to the DNS resolver. Here is a quick summary of the changes: * Added support for IPv6 lookups. * DNS queries now honor record expiration. * Added support for mDNS, compatible with "Bonjour". * Implemented a new lookup api, `resolv_lookup2()`, which provides more information about the state of the record(error, expired, looking-up, etc.). About mDNS/Bonjour Support -------------------------- This patch adds basic support for mDNS/Bonjour, which allows you to refer to the name of a device instead of its IP address. This is incredibly convenient for IPv6 addresses because they tend to be very long and difficult to remember. It is especially important for link-local IPv6 addresses, since not all programs support the '%' notation for indicating a network interface (required on systems with more than one network interface to disambiguate). In other words, instead of typing in this: * `http://[fe80::58dc:d7ed:a644:628f%en1]/` You can type this instead: * `http://contiki.local/` Huge improvement, no? The convenience extends beyond that: this mechanism can be used for nodes to talk to each other based on their human-readable names instead of their IPv6 addresses. So instead of a switch on `aaaa::58dc:d7ed:a644:628f` triggering an actuator on `aaaa::ed26:19c1:4bd2:f95b`, `light-switch.local` can trigger the actuator on `living-room-lights.local`. What you need to do to be able to look up `.local` names on your workstation depends on a few factors: * Your machine needs to be able to send and receive multicast packets to and from the LoWPAN. You can do this easily with the Jackdaw firmware on an RZUSBStick. If you have a border router, you will need it to bridge the mDNS multicast packets across the border. * If you are using a Mac, you win. All Apple devices support mDNS lookups. * If you are using Windows, you can install Apple's Bonjour for Windows package. (This may be already installed on your machine if you have installed iTunes) After you install this you can easily do `.local` lookups. * If you are using a Unix machine, you can install Avahi. The default hostname is set to `contiki.local.`. You can change the hostname programmatically by calling `resolv_set_hostname()`. You can change the default hostname by changing `CONTIKI_CONF_DEFAULT_HOSTNAME`. You may disable mDNS support by setting `RESOLV_CONF_SUPPORTS_MDNS` to `0`. --------------------------------- core/net/resolv: `resolv_lookup2()` -> `resolv_lookup()` Note that this patch should fix several `resolv_lookup()` bugs that already existed. There were many cases where `resolv_lookup()` was being called and the IP address ignored, but later code assumed that the IP address had been fetched... ANYWAY, those should be fixed now. --------------------------------- examples/udp-ipv6: Updated client to use MDNS to lookup the server. Also updated the Cooja regression test simulation.
2012-05-17 17:24:08 +02:00
enum {
/** Hostname is fresh and usable. This response is cached and will eventually
* expire to RESOLV_STATUS_EXPIRED.*/
RESOLV_STATUS_CACHED = 0,
/** Hostname was not found in the cache. Use resolv_query() to look it up. */
RESOLV_STATUS_UNCACHED,
/** Hostname was found, but it's status has expired. The address returned
* should not be used. Use resolv_query() to freshen it up.
*/
RESOLV_STATUS_EXPIRED,
/** The server has returned a not-found response for this domain name.
* This response is cached for the period described in the server.
* You may issue a new query at any time using resolv_query(), but
* you will generally want to wait until this domain's status becomes
* RESOLV_STATUS_EXPIRED.
*/
RESOLV_STATUS_NOT_FOUND,
/** This hostname is in the process of being resolved. Try again soon. */
RESOLV_STATUS_RESOLVING,
/** Some sort of server error was encountered while trying to look up this
* record. This response is cached and will eventually expire to
* RESOLV_STATUS_EXPIRED.
*/
RESOLV_STATUS_ERROR,
};
typedef uint8_t resolv_status_t;
/* Functions. */
core/net/resolv: IPv6 and mDNS ("Bonjour") support. Major refactor. This patch updates the DNS resolver to support IPv6 and introduces an improved API for looking up DNS entries. This patch also adds optional support for mDNS lookups and responses to the DNS resolver. Here is a quick summary of the changes: * Added support for IPv6 lookups. * DNS queries now honor record expiration. * Added support for mDNS, compatible with "Bonjour". * Implemented a new lookup api, `resolv_lookup2()`, which provides more information about the state of the record(error, expired, looking-up, etc.). About mDNS/Bonjour Support -------------------------- This patch adds basic support for mDNS/Bonjour, which allows you to refer to the name of a device instead of its IP address. This is incredibly convenient for IPv6 addresses because they tend to be very long and difficult to remember. It is especially important for link-local IPv6 addresses, since not all programs support the '%' notation for indicating a network interface (required on systems with more than one network interface to disambiguate). In other words, instead of typing in this: * `http://[fe80::58dc:d7ed:a644:628f%en1]/` You can type this instead: * `http://contiki.local/` Huge improvement, no? The convenience extends beyond that: this mechanism can be used for nodes to talk to each other based on their human-readable names instead of their IPv6 addresses. So instead of a switch on `aaaa::58dc:d7ed:a644:628f` triggering an actuator on `aaaa::ed26:19c1:4bd2:f95b`, `light-switch.local` can trigger the actuator on `living-room-lights.local`. What you need to do to be able to look up `.local` names on your workstation depends on a few factors: * Your machine needs to be able to send and receive multicast packets to and from the LoWPAN. You can do this easily with the Jackdaw firmware on an RZUSBStick. If you have a border router, you will need it to bridge the mDNS multicast packets across the border. * If you are using a Mac, you win. All Apple devices support mDNS lookups. * If you are using Windows, you can install Apple's Bonjour for Windows package. (This may be already installed on your machine if you have installed iTunes) After you install this you can easily do `.local` lookups. * If you are using a Unix machine, you can install Avahi. The default hostname is set to `contiki.local.`. You can change the hostname programmatically by calling `resolv_set_hostname()`. You can change the default hostname by changing `CONTIKI_CONF_DEFAULT_HOSTNAME`. You may disable mDNS support by setting `RESOLV_CONF_SUPPORTS_MDNS` to `0`. --------------------------------- core/net/resolv: `resolv_lookup2()` -> `resolv_lookup()` Note that this patch should fix several `resolv_lookup()` bugs that already existed. There were many cases where `resolv_lookup()` was being called and the IP address ignored, but later code assumed that the IP address had been fetched... ANYWAY, those should be fixed now. --------------------------------- examples/udp-ipv6: Updated client to use MDNS to lookup the server. Also updated the Cooja regression test simulation.
2012-05-17 17:24:08 +02:00
CCIF resolv_status_t resolv_lookup(const char *name, uip_ipaddr_t ** ipaddr);
CCIF void resolv_query(const char *name);
core/net/resolv: IPv6 and mDNS ("Bonjour") support. Major refactor. This patch updates the DNS resolver to support IPv6 and introduces an improved API for looking up DNS entries. This patch also adds optional support for mDNS lookups and responses to the DNS resolver. Here is a quick summary of the changes: * Added support for IPv6 lookups. * DNS queries now honor record expiration. * Added support for mDNS, compatible with "Bonjour". * Implemented a new lookup api, `resolv_lookup2()`, which provides more information about the state of the record(error, expired, looking-up, etc.). About mDNS/Bonjour Support -------------------------- This patch adds basic support for mDNS/Bonjour, which allows you to refer to the name of a device instead of its IP address. This is incredibly convenient for IPv6 addresses because they tend to be very long and difficult to remember. It is especially important for link-local IPv6 addresses, since not all programs support the '%' notation for indicating a network interface (required on systems with more than one network interface to disambiguate). In other words, instead of typing in this: * `http://[fe80::58dc:d7ed:a644:628f%en1]/` You can type this instead: * `http://contiki.local/` Huge improvement, no? The convenience extends beyond that: this mechanism can be used for nodes to talk to each other based on their human-readable names instead of their IPv6 addresses. So instead of a switch on `aaaa::58dc:d7ed:a644:628f` triggering an actuator on `aaaa::ed26:19c1:4bd2:f95b`, `light-switch.local` can trigger the actuator on `living-room-lights.local`. What you need to do to be able to look up `.local` names on your workstation depends on a few factors: * Your machine needs to be able to send and receive multicast packets to and from the LoWPAN. You can do this easily with the Jackdaw firmware on an RZUSBStick. If you have a border router, you will need it to bridge the mDNS multicast packets across the border. * If you are using a Mac, you win. All Apple devices support mDNS lookups. * If you are using Windows, you can install Apple's Bonjour for Windows package. (This may be already installed on your machine if you have installed iTunes) After you install this you can easily do `.local` lookups. * If you are using a Unix machine, you can install Avahi. The default hostname is set to `contiki.local.`. You can change the hostname programmatically by calling `resolv_set_hostname()`. You can change the default hostname by changing `CONTIKI_CONF_DEFAULT_HOSTNAME`. You may disable mDNS support by setting `RESOLV_CONF_SUPPORTS_MDNS` to `0`. --------------------------------- core/net/resolv: `resolv_lookup2()` -> `resolv_lookup()` Note that this patch should fix several `resolv_lookup()` bugs that already existed. There were many cases where `resolv_lookup()` was being called and the IP address ignored, but later code assumed that the IP address had been fetched... ANYWAY, those should be fixed now. --------------------------------- examples/udp-ipv6: Updated client to use MDNS to lookup the server. Also updated the Cooja regression test simulation.
2012-05-17 17:24:08 +02:00
#if RESOLV_CONF_SUPPORTS_MDNS
CCIF void resolv_set_hostname(const char *hostname);
CCIF const char *resolv_get_hostname(void);
#endif
PROCESS_NAME(resolv_process);
#endif /* RESOLV_H_ */