DnsImpl.h

Go to the documentation of this file.

 
#ifndef __EFI_DNS_IMPL_H_
#define __EFI_DNS_IMPL_H_
 
#include <Uefi.h>
 
//
// Libraries classes
//
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/NetLib.h>
#include <Library/DebugLib.h>
#include <Library/DpcLib.h>
#include <Library/PrintLib.h>
#include <Library/UdpIoLib.h>
 
//
// UEFI Driver Model Protocols
//
#include <Protocol/DriverBinding.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/ComponentName.h>
 
#include <Protocol/Udp4.h>
#include <Protocol/Dhcp4.h>
#include <Protocol/Dns4.h>
 
#include <Protocol/Udp6.h>
#include <Protocol/Dhcp6.h>
#include <Protocol/Dns6.h>
 
#include <Protocol/Ip4Config2.h>
 
#include "DnsDriver.h"
#include "DnsDhcp.h"
 
//
// Driver Version
//
#define DNS_VERSION  0x00000000
 
//
// Protocol instances
//
extern EFI_COMPONENT_NAME_PROTOCOL   gDnsComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gDnsComponentName2;
extern EFI_UNICODE_STRING_TABLE      *gDnsControllerNameTable;
 
extern EFI_DRIVER_BINDING_PROTOCOL   gDns4DriverBinding;
extern EFI_SERVICE_BINDING_PROTOCOL  mDns4ServiceBinding;
extern EFI_DNS4_PROTOCOL             mDns4Protocol;
 
extern EFI_DRIVER_BINDING_PROTOCOL   gDns6DriverBinding;
extern EFI_SERVICE_BINDING_PROTOCOL  mDns6ServiceBinding;
extern EFI_DNS6_PROTOCOL             mDns6Protocol;
 
//
// DNS related
//
#define DNS_SERVER_PORT  53
 
#define DNS_PROTOCOL_UDP  EFI_IP_PROTO_UDP
#define DNS_PROTOCOL_TCP  EFI_IP_PROTO_TCP
 
#define DNS_STATE_UNCONFIGED  0
#define DNS_STATE_CONFIGED    1
#define DNS_STATE_DESTROY     2
 
#define DNS_DEFAULT_TIMEOUT  2
 
#define DNS_TIME_TO_GETMAP  5
 
#pragma pack(1)
 
typedef union _DNS_FLAGS DNS_FLAGS;
 
typedef struct {
  LIST_ENTRY              AllCacheLink;
  EFI_DNS4_CACHE_ENTRY    DnsCache;
} DNS4_CACHE;
 
typedef struct {
  LIST_ENTRY              AllCacheLink;
  EFI_DNS6_CACHE_ENTRY    DnsCache;
} DNS6_CACHE;
 
typedef struct {
  LIST_ENTRY          AllServerLink;
  EFI_IPv4_ADDRESS    Dns4ServerIp;
} DNS4_SERVER_IP;
 
typedef struct {
  LIST_ENTRY          AllServerLink;
  EFI_IPv6_ADDRESS    Dns6ServerIp;
} DNS6_SERVER_IP;
 
typedef struct {
  UINT32                       RetryCounting;
  UINT32                       PacketToLive;
  CHAR16                       *QueryHostName;
  EFI_IPv4_ADDRESS             QueryIpAddress;
  BOOLEAN                      GeneralLookUp;
  EFI_DNS4_COMPLETION_TOKEN    *Token;
} DNS4_TOKEN_ENTRY;
 
typedef struct {
  UINT32                       RetryCounting;
  UINT32                       PacketToLive;
  CHAR16                       *QueryHostName;
  EFI_IPv6_ADDRESS             QueryIpAddress;
  BOOLEAN                      GeneralLookUp;
  EFI_DNS6_COMPLETION_TOKEN    *Token;
} DNS6_TOKEN_ENTRY;
 
union _DNS_FLAGS {
  struct {
    UINT16    RCode  : 4;
    UINT16    Zero   : 3;
    UINT16    RA     : 1;
    UINT16    RD     : 1;
    UINT16    TC     : 1;
    UINT16    AA     : 1;
    UINT16    OpCode : 4;
    UINT16    QR     : 1;
  } Bits;
  UINT16    Uint16;
};
 
#define DNS_FLAGS_QR_QUERY     0
#define DNS_FLAGS_QR_RESPONSE  1
 
#define DNS_FLAGS_OPCODE_STANDARD      0
#define DNS_FLAGS_OPCODE_INVERSE       1
#define DNS_FLAGS_OPCODE_SERVER_STATE  2
 
#define DNS_FLAGS_RCODE_NO_ERROR    0
#define DNS_FLAGS_RCODE_NAME_ERROR  3
 
typedef struct {
  UINT16       Identification;
  DNS_FLAGS    Flags;
  UINT16       QuestionsNum;
  UINT16       AnswersNum;
  UINT16       AuthorityNum;
  UINT16       AditionalNum;
} DNS_HEADER;
 
typedef struct {
  UINT16    Type;
  UINT16    Class;
} DNS_QUERY_SECTION;
 
typedef struct {
  UINT16    Type;
  UINT16    Class;
  UINT32    Ttl;
  UINT16    DataLength;
} DNS_ANSWER_SECTION;
 
#define DNS4_DOMAIN  L"in-addr.arpa"
#define DNS6_DOMAIN  L"IP6.ARPA"
 
#pragma pack()
 
EFI_STATUS
Dns4RemoveTokenEntry (
  IN NET_MAP           *TokenMap,
  IN DNS4_TOKEN_ENTRY  *TokenEntry
  );
 
EFI_STATUS
Dns6RemoveTokenEntry (
  IN NET_MAP           *TokenMap,
  IN DNS6_TOKEN_ENTRY  *TokenEntry
  );
 
EFI_STATUS
EFIAPI
Dns4CancelTokens (
  IN NET_MAP       *Map,
  IN NET_MAP_ITEM  *Item,
  IN VOID          *Arg OPTIONAL
  );
 
EFI_STATUS
EFIAPI
Dns6CancelTokens (
  IN NET_MAP       *Map,
  IN NET_MAP_ITEM  *Item,
  IN VOID          *Arg OPTIONAL
  );
 
EFI_STATUS
EFIAPI
GetDns4TokenEntry (
  IN     NET_MAP                    *TokensMap,
  IN     EFI_DNS4_COMPLETION_TOKEN  *Token,
  OUT DNS4_TOKEN_ENTRY              **TokenEntry
  );
 
EFI_STATUS
EFIAPI
GetDns6TokenEntry (
  IN     NET_MAP                    *TokensMap,
  IN     EFI_DNS6_COMPLETION_TOKEN  *Token,
  OUT DNS6_TOKEN_ENTRY              **TokenEntry
  );
 
EFI_STATUS
Dns4InstanceCancelToken (
  IN DNS_INSTANCE               *Instance,
  IN EFI_DNS4_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
Dns6InstanceCancelToken (
  IN DNS_INSTANCE               *Instance,
  IN EFI_DNS6_COMPLETION_TOKEN  *Token
  );
 
VOID
Dns4CleanConfigure (
  IN OUT EFI_DNS4_CONFIG_DATA  *Config
  );
 
VOID
Dns6CleanConfigure (
  IN OUT EFI_DNS6_CONFIG_DATA  *Config
  );
 
EFI_STATUS
Dns4CopyConfigure (
  OUT EFI_DNS4_CONFIG_DATA  *Dst,
  IN  EFI_DNS4_CONFIG_DATA  *Src
  );
 
EFI_STATUS
Dns6CopyConfigure (
  OUT EFI_DNS6_CONFIG_DATA  *Dst,
  IN  EFI_DNS6_CONFIG_DATA  *Src
  );
 
VOID
EFIAPI
DnsDummyExtFree (
  IN VOID  *Arg
  );
 
BOOLEAN
Dns4GetMapping (
  IN DNS_INSTANCE          *Instance,
  IN UDP_IO                *UdpIo,
  IN EFI_UDP4_CONFIG_DATA  *UdpCfgData
  );
 
BOOLEAN
Dns6GetMapping (
  IN DNS_INSTANCE          *Instance,
  IN UDP_IO                *UdpIo,
  IN EFI_UDP6_CONFIG_DATA  *UdpCfgData
  );
 
EFI_STATUS
Dns4ConfigUdp (
  IN DNS_INSTANCE  *Instance,
  IN UDP_IO        *UdpIo
  );
 
EFI_STATUS
Dns6ConfigUdp (
  IN DNS_INSTANCE  *Instance,
  IN UDP_IO        *UdpIo
  );
 
EFI_STATUS
EFIAPI
UpdateDns4Cache (
  IN LIST_ENTRY            *Dns4CacheList,
  IN BOOLEAN               DeleteFlag,
  IN BOOLEAN               Override,
  IN EFI_DNS4_CACHE_ENTRY  DnsCacheEntry
  );
 
EFI_STATUS
EFIAPI
UpdateDns6Cache (
  IN LIST_ENTRY            *Dns6CacheList,
  IN BOOLEAN               DeleteFlag,
  IN BOOLEAN               Override,
  IN EFI_DNS6_CACHE_ENTRY  DnsCacheEntry
  );
 
EFI_STATUS
EFIAPI
AddDns4ServerIp (
  IN LIST_ENTRY        *Dns4ServerList,
  IN EFI_IPv4_ADDRESS  ServerIp
  );
 
EFI_STATUS
EFIAPI
AddDns6ServerIp (
  IN LIST_ENTRY        *Dns6ServerList,
  IN EFI_IPv6_ADDRESS  ServerIp
  );
 
BOOLEAN
IsValidDnsResponse (
  IN     NET_MAP    *TokensMap,
  IN     UINT16     Identification,
  IN     UINT16     Type,
  IN     UINT16     Class,
  OUT NET_MAP_ITEM  **Item
  );
 
EFI_STATUS
ParseDnsResponse (
  IN OUT DNS_INSTANCE  *Instance,
  IN     UINT8         *RxString,
  IN     UINT32        Length,
  OUT BOOLEAN          *Completed
  );
 
VOID
EFIAPI
DnsOnPacketReceived (
  NET_BUF        *Packet,
  UDP_END_POINT  *EndPoint,
  EFI_STATUS     IoStatus,
  VOID           *Context
  );
 
VOID
EFIAPI
DnsOnPacketSent (
  NET_BUF        *Packet,
  UDP_END_POINT  *EndPoint,
  EFI_STATUS     IoStatus,
  VOID           *Context
  );
 
EFI_STATUS
DoDnsQuery (
  IN  DNS_INSTANCE  *Instance,
  IN  NET_BUF       *Packet
  );
 
EFI_STATUS
ConstructDNSQuery (
  IN  DNS_INSTANCE  *Instance,
  IN  CHAR8         *QueryName,
  IN  UINT16        Type,
  IN  UINT16        Class,
  OUT NET_BUF       **Packet
  );
 
EFI_STATUS
DnsRetransmit (
  IN DNS_INSTANCE  *Instance,
  IN NET_BUF       *Packet
  );
 
VOID
EFIAPI
DnsOnTimerRetransmit (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
DnsOnTimerUpdate (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
EFIAPI
Dns4GetModeData (
  IN  EFI_DNS4_PROTOCOL   *This,
  OUT EFI_DNS4_MODE_DATA  *DnsModeData
  );
 
EFI_STATUS
EFIAPI
Dns4Configure (
  IN EFI_DNS4_PROTOCOL     *This,
  IN EFI_DNS4_CONFIG_DATA  *DnsConfigData
  );
 
EFI_STATUS
EFIAPI
Dns4HostNameToIp (
  IN  EFI_DNS4_PROTOCOL          *This,
  IN  CHAR16                     *HostName,
  IN  EFI_DNS4_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns4IpToHostName (
  IN  EFI_DNS4_PROTOCOL          *This,
  IN  EFI_IPv4_ADDRESS           IpAddress,
  IN  EFI_DNS4_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns4GeneralLookUp (
  IN  EFI_DNS4_PROTOCOL          *This,
  IN  CHAR8                      *QName,
  IN  UINT16                     QType,
  IN  UINT16                     QClass,
  IN  EFI_DNS4_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns4UpdateDnsCache (
  IN EFI_DNS4_PROTOCOL     *This,
  IN BOOLEAN               DeleteFlag,
  IN BOOLEAN               Override,
  IN EFI_DNS4_CACHE_ENTRY  DnsCacheEntry
  );
 
EFI_STATUS
EFIAPI
Dns4Poll (
  IN EFI_DNS4_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
Dns4Cancel (
  IN  EFI_DNS4_PROTOCOL          *This,
  IN  EFI_DNS4_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns6GetModeData (
  IN  EFI_DNS6_PROTOCOL   *This,
  OUT EFI_DNS6_MODE_DATA  *DnsModeData
  );
 
EFI_STATUS
EFIAPI
Dns6Configure (
  IN EFI_DNS6_PROTOCOL     *This,
  IN EFI_DNS6_CONFIG_DATA  *DnsConfigData
  );
 
EFI_STATUS
EFIAPI
Dns6HostNameToIp (
  IN  EFI_DNS6_PROTOCOL          *This,
  IN  CHAR16                     *HostName,
  IN  EFI_DNS6_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns6IpToHostName (
  IN  EFI_DNS6_PROTOCOL          *This,
  IN  EFI_IPv6_ADDRESS           IpAddress,
  IN  EFI_DNS6_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns6GeneralLookUp (
  IN  EFI_DNS6_PROTOCOL          *This,
  IN  CHAR8                      *QName,
  IN  UINT16                     QType,
  IN  UINT16                     QClass,
  IN  EFI_DNS6_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
Dns6UpdateDnsCache (
  IN EFI_DNS6_PROTOCOL     *This,
  IN BOOLEAN               DeleteFlag,
  IN BOOLEAN               Override,
  IN EFI_DNS6_CACHE_ENTRY  DnsCacheEntry
  );
 
EFI_STATUS
EFIAPI
Dns6Poll (
  IN EFI_DNS6_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
Dns6Cancel (
  IN  EFI_DNS6_PROTOCOL          *This,
  IN  EFI_DNS6_COMPLETION_TOKEN  *Token
  );
 
#endif