Dhcp6Impl.h

Go to the documentation of this file.

 
#ifndef __EFI_DHCP6_IMPL_H__
#define __EFI_DHCP6_IMPL_H__
 
#include <Uefi.h>
 
#include <IndustryStandard/Dhcp.h>
 
#include <Protocol/Dhcp6.h>
#include <Protocol/Udp6.h>
#include <Protocol/Ip6Config.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/DriverBinding.h>
 
#include <Library/UdpIoLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseLib.h>
#include <Library/NetLib.h>
#include <Library/PrintLib.h>
#include <Guid/ZeroGuid.h>
 
typedef struct _DHCP6_IA_CB     DHCP6_IA_CB;
typedef struct _DHCP6_INF_CB    DHCP6_INF_CB;
typedef struct _DHCP6_TX_CB     DHCP6_TX_CB;
typedef struct _DHCP6_SERVICE   DHCP6_SERVICE;
typedef struct _DHCP6_INSTANCE  DHCP6_INSTANCE;
 
#include "Dhcp6Utility.h"
#include "Dhcp6Io.h"
#include "Dhcp6Driver.h"
 
#define DHCP6_SERVICE_SIGNATURE   SIGNATURE_32 ('D', 'H', '6', 'S')
#define DHCP6_INSTANCE_SIGNATURE  SIGNATURE_32 ('D', 'H', '6', 'I')
 
#define DHCP6_PACKET_ALL        0
#define DHCP6_PACKET_STATEFUL   1
#define DHCP6_PACKET_STATELESS  2
 
#define DHCP6_BASE_PACKET_SIZE  1024
 
#define DHCP6_PORT_CLIENT  546
#define DHCP6_PORT_SERVER  547
 
#define DHCP_CHECK_MEDIA_WAITING_TIME  EFI_TIMER_PERIOD_SECONDS(20)
 
#define DHCP6_INSTANCE_FROM_THIS(Instance)  CR ((Instance), DHCP6_INSTANCE, Dhcp6, DHCP6_INSTANCE_SIGNATURE)
#define DHCP6_SERVICE_FROM_THIS(Service)    CR ((Service), DHCP6_SERVICE, ServiceBinding, DHCP6_SERVICE_SIGNATURE)
 
//
// For more information on DHCP options see RFC 8415, Section 21.1
//
// The format of DHCP options is:
//
//     0                   1                   2                   3
//     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |          option-code          |           option-len          |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |                          option-data                          |
//    |                      (option-len octets)                      |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//
#define DHCP6_SIZE_OF_OPT_CODE  (sizeof (((EFI_DHCP6_PACKET_OPTION *)0)->OpCode))
#define DHCP6_SIZE_OF_OPT_LEN   (sizeof (((EFI_DHCP6_PACKET_OPTION *)0)->OpLen))
 
// Combined size of Code and Length
#define DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN  (DHCP6_SIZE_OF_OPT_CODE + \
                                              DHCP6_SIZE_OF_OPT_LEN)
 
STATIC_ASSERT (
  DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN == 4,
  "Combined size of Code and Length must be 4 per RFC 8415"
  );
 
// Offset to the length is just past the code
#define DHCP6_OFFSET_OF_OPT_LEN(a)  (a + DHCP6_SIZE_OF_OPT_CODE)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_OPT_LEN (0) == 2,
  "Offset of length is + 2 past start of option"
  );
 
#define DHCP6_OFFSET_OF_OPT_DATA(a)  (a + DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_OPT_DATA (0) == 4,
  "Offset to option data should be +4 from start of option"
  );
//
// Identity Association options (both NA (Non-Temporary) and TA (Temporary Association))
// are defined in RFC 8415 and are a deriviation of a TLV stucture
// For more information on IA_NA see Section 21.4
// For more information on IA_TA see Section 21.5
//
//
//  The format of IA_NA and IA_TA option:
//
//     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |          OPTION_IA_NA         |          option-len           |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |                        IAID (4 octets)                        |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |                        T1 (only for IA_NA)                    |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |                        T2 (only for IA_NA)                    |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |                                                               |
//    .                  IA_NA-options/IA_TA-options                  .
//    .                                                               .
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//
#define DHCP6_SIZE_OF_IAID           (sizeof(UINT32))
#define DHCP6_SIZE_OF_TIME_INTERVAL  (sizeof(UINT32))
 
// Combined size of IAID, T1, and T2
#define DHCP6_SIZE_OF_COMBINED_IAID_T1_T2  (DHCP6_SIZE_OF_IAID +  \
                                            DHCP6_SIZE_OF_TIME_INTERVAL + \
                                            DHCP6_SIZE_OF_TIME_INTERVAL)
STATIC_ASSERT (
  DHCP6_SIZE_OF_COMBINED_IAID_T1_T2 == 12,
  "Combined size of IAID, T1, T2 must be 12 per RFC 8415"
  );
 
// This is the size of IA_TA without options
#define DHCP6_MIN_SIZE_OF_IA_TA  (DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN + \
                                  DHCP6_SIZE_OF_IAID)
STATIC_ASSERT (
  DHCP6_MIN_SIZE_OF_IA_TA == 8,
  "Minimum combined size of IA_TA per RFC 8415"
  );
 
// Offset to a IA_TA inner option
#define DHCP6_OFFSET_OF_IA_TA_INNER_OPT(a)  (a + DHCP6_MIN_SIZE_OF_IA_TA)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_IA_TA_INNER_OPT (0) == 8,
  "Offset of IA_TA Inner option is + 8 past start of option"
  );
 
// This is the size of IA_NA without options (16)
#define DHCP6_MIN_SIZE_OF_IA_NA  DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN + \
                                 DHCP6_SIZE_OF_COMBINED_IAID_T1_T2
STATIC_ASSERT (
  DHCP6_MIN_SIZE_OF_IA_NA == 16,
  "Minimum combined size of IA_TA per RFC 8415"
  );
 
#define DHCP6_OFFSET_OF_IA_NA_INNER_OPT(a)  (a + DHCP6_MIN_SIZE_OF_IA_NA)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_IA_NA_INNER_OPT (0) == 16,
  "Offset of IA_NA Inner option is + 16 past start of option"
  );
 
#define DHCP6_OFFSET_OF_IA_NA_T1(a)  (a + \
                                   DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN + \
                                   DHCP6_SIZE_OF_IAID)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_IA_NA_T1 (0) == 8,
  "Offset of IA_NA Inner option is + 8 past start of option"
  );
 
#define DHCP6_OFFSET_OF_IA_NA_T2(a)  (a + \
                                   DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN +\
                                   DHCP6_SIZE_OF_IAID + \
                                   DHCP6_SIZE_OF_TIME_INTERVAL)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_IA_NA_T2 (0) == 12,
  "Offset of IA_NA Inner option is + 12 past start of option"
  );
 
//
// For more information see RFC 8415 Section 21.13
//
// The format of the Status Code Option:
//
//     0                   1                   2                   3
//     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |       OPTION_STATUS_CODE      |         option-len            |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//    |          status-code          |                               |
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
//    .                                                               .
//    .                        status-message                         .
//    .                                                               .
//    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
//
#define DHCP6_OFFSET_OF_STATUS_CODE(a)  (a + DHCP6_SIZE_OF_COMBINED_CODE_AND_LEN)
STATIC_ASSERT (
  DHCP6_OFFSET_OF_STATUS_CODE (0) == 4,
  "Offset of status is + 4 past start of option"
  );
 
extern EFI_IPv6_ADDRESS    mAllDhcpRelayAndServersAddress;
extern EFI_DHCP6_PROTOCOL  gDhcp6ProtocolTemplate;
 
//
// Control block for each IA.
//
struct _DHCP6_IA_CB {
  EFI_DHCP6_IA    *Ia;
  UINT32          T1;
  UINT32          T2;
  UINT32          AllExpireTime;
  UINT32          LeaseTime;
};
 
//
// Control block for each transmitted message.
//
struct _DHCP6_TX_CB {
  LIST_ENTRY                  Link;
  UINT32                      Xid;
  EFI_DHCP6_PACKET            *TxPacket;
  EFI_DHCP6_RETRANSMISSION    RetryCtl;
  UINT32                      RetryCnt;
  UINT32                      RetryExp;
  UINT32                      RetryLos;
  UINT32                      TickTime;
  UINT16                      *Elapsed;
  BOOLEAN                     SolicitRetry;
};
 
//
// Control block for each info-request message.
//
struct _DHCP6_INF_CB {
  LIST_ENTRY                 Link;
  UINT32                     Xid;
  EFI_DHCP6_INFO_CALLBACK    ReplyCallback;
  VOID                       *CallbackContext;
  EFI_EVENT                  TimeoutEvent;
};
 
//
// Control block for Dhcp6 instance, it's per configuration data.
//
struct _DHCP6_INSTANCE {
  UINT32                   Signature;
  EFI_HANDLE               Handle;
  DHCP6_SERVICE            *Service;
  LIST_ENTRY               Link;
  EFI_DHCP6_PROTOCOL       Dhcp6;
  EFI_EVENT                Timer;
  EFI_DHCP6_CONFIG_DATA    *Config;
  EFI_DHCP6_IA             *CacheIa;
  DHCP6_IA_CB              IaCb;
  LIST_ENTRY               TxList;
  LIST_ENTRY               InfList;
  EFI_DHCP6_PACKET         *AdSelect;
  UINT8                    AdPref;
  EFI_IPv6_ADDRESS         *Unicast;
  volatile EFI_STATUS      UdpSts;
  BOOLEAN                  InDestroy;
  BOOLEAN                  MediaPresent;
  //
  // StartTime is used to calculate the 'elapsed-time' option. Refer to RFC3315,
  // the elapsed-time is amount of time since the client began its current DHCP transaction.
  //
  UINT64                   StartTime;
};
 
//
// Control block for Dhcp6 service, it's per Nic handle.
//
struct _DHCP6_SERVICE {
  UINT32                          Signature;
  EFI_HANDLE                      Controller;
  EFI_HANDLE                      Image;
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;
  EFI_SIMPLE_NETWORK_PROTOCOL     *Snp;
  EFI_IP6_CONFIG_PROTOCOL         *Ip6Cfg;
  EFI_DHCP6_DUID                  *ClientId;
  UDP_IO                          *UdpIo;
  UINT32                          Xid;
  LIST_ENTRY                      Child;
  UINTN                           NumOfChild;
};
 
EFI_STATUS
EFIAPI
EfiDhcp6Start (
  IN EFI_DHCP6_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6Stop (
  IN EFI_DHCP6_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6GetModeData (
  IN  EFI_DHCP6_PROTOCOL     *This,
  OUT EFI_DHCP6_MODE_DATA    *Dhcp6ModeData      OPTIONAL,
  OUT EFI_DHCP6_CONFIG_DATA  *Dhcp6ConfigData    OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6Configure (
  IN EFI_DHCP6_PROTOCOL     *This,
  IN EFI_DHCP6_CONFIG_DATA  *Dhcp6CfgData    OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6InfoRequest (
  IN EFI_DHCP6_PROTOCOL        *This,
  IN BOOLEAN                   SendClientId,
  IN EFI_DHCP6_PACKET_OPTION   *OptionRequest,
  IN UINT32                    OptionCount,
  IN EFI_DHCP6_PACKET_OPTION   *OptionList[]    OPTIONAL,
  IN EFI_DHCP6_RETRANSMISSION  *Retransmission,
  IN EFI_EVENT                 TimeoutEvent     OPTIONAL,
  IN EFI_DHCP6_INFO_CALLBACK   ReplyCallback,
  IN VOID                      *CallbackContext OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6RenewRebind (
  IN EFI_DHCP6_PROTOCOL  *This,
  IN BOOLEAN             RebindRequest
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6Decline (
  IN EFI_DHCP6_PROTOCOL  *This,
  IN UINT32              AddressCount,
  IN EFI_IPv6_ADDRESS    *Addresses
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6Release (
  IN EFI_DHCP6_PROTOCOL  *This,
  IN UINT32              AddressCount,
  IN EFI_IPv6_ADDRESS    *Addresses
  );
 
EFI_STATUS
EFIAPI
EfiDhcp6Parse (
  IN EFI_DHCP6_PROTOCOL        *This,
  IN EFI_DHCP6_PACKET          *Packet,
  IN OUT UINT32                *OptionCount,
  OUT EFI_DHCP6_PACKET_OPTION  *PacketOptionList[]  OPTIONAL
  );
 
#endif