DnsResult.hxx

Go to the documentation of this file.

#if !defined(RESIP_DNSRESULT_HXX)
#define RESIP_DNSRESULT_HXX
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
 
#include <iosfwd>
#include <set>
#include <vector>
#include <deque>
#include <map>
#include <stack>
 
#include "resip/stack/Tuple.hxx"
#include "resip/stack/Transport.hxx"
#include "resip/stack/Uri.hxx"
#include "resip/stack/TupleMarkManager.hxx"
#include "rutil/Condition.hxx"
#include "rutil/HeapInstanceCounter.hxx"
#include "rutil/dns/RRVip.hxx"
#include "rutil/dns/DnsStub.hxx"
 
#ifdef WIN32
#include <Ws2tcpip.h>
#endif
 
struct hostent;
 
namespace resip
{
class DnsInterface;
class DnsAAAARecord;
class DnsHandler;
class WhiteListLastCommand;
 
class EnumResultSink
{
   public:
      virtual void onEnumResult(const DNSResult<DnsNaptrRecord>& result, int order) = 0;
};
 
class EnumResult : public DnsResultSink
{
   public:
      EnumResult(EnumResultSink& resultSink, int order);
      ~EnumResult();
 
      // DnsResultSink
      void onDnsResult(const DNSResult<DnsHostRecord>&);
      void onDnsResult(const DNSResult<DnsAAAARecord>&);
      void onDnsResult(const DNSResult<DnsSrvRecord>&);
      void onDnsResult(const DNSResult<DnsNaptrRecord>&);
      void onDnsResult(const DNSResult<DnsCnameRecord>&);
 
      void onEnumResult(const DNSResult<DnsNaptrRecord>& result);
      void onNaptrResult(const DNSResult<DnsNaptrRecord>& result);
 
   private:
      EnumResultSink& mResultSink;
      int mOrder;
};
 
class DnsResult : public DnsResultSink, public EnumResultSink
{
   public:
      RESIP_HeapCount(DnsResult);
      DnsResult(DnsInterface& interfaceObj, DnsStub& dns, RRVip& vip, DnsHandler* handler);
      virtual ~DnsResult();
 
      typedef enum
      {
         Available, // A result is available now
         Pending,   // More results may be pending 
         Finished,  // No more results available and none pending
         Destroyed  // the associated transaction has been deleted
                     // (ie, this DnsResult will delete itself as soon as it
                     // gets a new result)
      } Type;
 
      typedef std::vector<Data> DataVector;
 
      void lookup(const Uri& uri);
 
      bool blacklistLast(uint64_t expiry);
      
      bool greylistLast(uint64_t expiry);
      
      Type available();
      
      Tuple next();
 
      void whitelistLast();
 
      // return the target of associated query
      // Safe to call after DnsHandler::handle callback has been called.
      Data target() const { return mTarget; }
      unsigned int getSRVResultsSize() const {return (unsigned int)mSRVResults.size();}
 
      // Will delete this DnsResult if no pending queries are out there or wait
      // until the pending queries get responses and then delete
      void destroy();
 
      // Used to store a NAPTR result
      class NAPTR
      {
         public:
            NAPTR();
            // As defined by RFC3263
            bool operator<(const NAPTR& rhs) const;
 
            Data key; // NAPTR record key
            
            int order;
            int pref;
            Data flags;
            Data service;
            DnsNaptrRecord::RegExp regex;
            Data replacement;
      };
      
      class SRV
      {
         public:
            SRV();
            // As defined by RFC3263, RFC2782
            bool operator<(const SRV& rhs) const;
            
            Data key; // SRV record key
            
            int naptrpref;
            TransportType transport;
            int priority;
            int weight;
            int port;
            Data target;
      };
 
   private:
 
      /*
         The following command is used to ensure that all DnsInterface mRRVip and 
         mTupleMarkManager, and enum setting accesses are done from the DnsThread.  
         This gets the initial call * lookupInternalWithEnum to occur on the 
         DnsThread (using the DnsStub command fifo).
       */
      class LookupCommand : public DnsStub::Command
      {
      public:
          LookupCommand(DnsResult& dnsResult, const Uri& uri) : mDnsResult(dnsResult), mUri(uri) {}
          virtual ~LookupCommand() {}
          virtual void execute()
          {
              mDnsResult.lookupInternalWithEnum(mUri);
          }
      private:
          DnsResult& mDnsResult;
          Uri mUri;
      };
      friend class LookupCommand;
      void lookupInternalWithEnum(const Uri& uri);
      void lookupInternal(const Uri& uri);
 
      // Given a transport and port from uri, return the default port to use
      int getDefaultPort(TransportType transport, int port);
      
      void lookupHost(const Data& target);
      
      // compute the cumulative weights for the SRV entries with the lowest
      // priority, then randomly pick according to RFC2782 from the entries with
      // the lowest priority based on weights. When all entries at the lowest
      // priority are chosen, pick the next lowest priority and repeat. After an
      // SRV entry is selected, remove it from mSRVResults
      SRV retrieveSRV();
      
      // Will retrieve the next SRV record and compute the prime the mResults
      // with the appropriate Tuples. 
      void primeResults();
      
   private:
      DnsInterface& mInterface;
      DnsStub& mDnsStub;
      RRVip& mVip;
      DnsHandler* mHandler;
      int mSRVCount;
      Uri mInputUri;
      int mDoingEnum;
      std::map<int,Uri> mEnumDestinations;
      resip::Mutex mEnumDestinationsMutex;
      
      bool mSips;
      Data mTarget;
      Data mSrvKey;
      TransportType mTransport; // current
      int mPort; // current
      
      bool mHaveChosenTransport;
      
      Type mType;
 
      //Ugly hack
      Data mPassHostFromAAAAtoA;
 
      void transition(Type t);      
      
      // This is where the current pending (ordered) results are stored. As they
      // are retrieved by calling next(), they are popped from the front of the list
      std::deque<Tuple> mResults;
      std::vector<Tuple> mGreylistedTuples;
      
      // Map of NAPTR records by replacement (ie. SRV lookup key)
      std::map<Data, NAPTR> mTopOrderedNAPTRs;
 
      // used in determining the next SRV record to use as per rfc2782
      int mCumulativeWeight; // for current priority
 
      // All SRV records sorted in order of preference
      std::vector<SRV> mSRVResults;
      
      friend class DnsInterface;
      friend EncodeStream& operator<<(EncodeStream& strm, const DnsResult&);
      friend EncodeStream& operator<<(EncodeStream& strm, const DnsResult::SRV&);
      friend EncodeStream& operator<<(EncodeStream& strm, const DnsResult::NAPTR&);
 
      // DnsResultSink
      void onDnsResult(const DNSResult<DnsHostRecord>&);
      void onDnsResult(const DNSResult<DnsAAAARecord>&);
      void onDnsResult(const DNSResult<DnsSrvRecord>&);
      void onDnsResult(const DNSResult<DnsNaptrRecord>&);
      void onDnsResult(const DNSResult<DnsCnameRecord>&);
 
      void onEnumResult(const DNSResult<DnsNaptrRecord>& result, int order);
      void onNaptrResult(const DNSResult<DnsNaptrRecord>& result);
 
      typedef struct
      {
         Data domain;
         int rrType;
         Data value; // stores ip for A/AAAA, target host:port for SRV, and replacement for NAPTR.
      } Item;
 
      std::vector<Item> mLastReturnedPath;
      
      std::vector<Item> mCurrentPath;
      bool mHaveReturnedResults;
      void clearCurrPath();
      Tuple mLastResult;
 
      /*
         The following two commands are to ensure that all DnsInterface mVip 
         and mTupleMarkManager calls are done from the DnsThread (using the 
         DnsStub command fifo).
      */
      class WhitelistCommand : public DnsStub::Command
      {
      public:
         WhitelistCommand(RRVip& vip, TupleMarkManager& markManager, std::vector<Item>& path, Tuple& result) : mVip(vip), mMarkManager(markManager), mPath(path), mResult(result) {}
         virtual ~WhitelistCommand() {}
         virtual void execute();
      private:
         RRVip& mVip;
         TupleMarkManager& mMarkManager;
         std::vector<Item> mPath;
         Tuple mResult;
      };
 
      class GreyOrBlacklistCommand : public DnsStub::Command
      {
      public:
         GreyOrBlacklistCommand(RRVip& vip, TupleMarkManager& markManager, Item& pathTop, Tuple& result, uint64_t expiry, TupleMarkManager::MarkType markType) : 
            mVip(vip), mMarkManager(markManager), mPathTop(pathTop), mResult(result), mExpiry(expiry), mMarkType(markType) {}
         virtual ~GreyOrBlacklistCommand() {}
         virtual void execute();
      private:
         RRVip& mVip;
         TupleMarkManager& mMarkManager;
         Item mPathTop;
         Tuple mResult;
         uint64_t mExpiry;
         TupleMarkManager::MarkType mMarkType;
      };
};
 
EncodeStream& operator<<(EncodeStream& strm, const DnsResult&);
EncodeStream& operator<<(EncodeStream& strm, const DnsResult::SRV&);
EncodeStream& operator<<(EncodeStream& strm, const DnsResult::NAPTR&);
 
}
 
#endif
 
//  Copyright (c) 2003, Jason Fischl 
/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, 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:
 * 
 * 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 names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact vocal@vovida.org.
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY 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 software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */