4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6 support functions implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Generate client Duid in the format of Duid-llt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Mode The pointer to the mode of SNP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If it failed to generate a client Id.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval others The pointer to the new client id.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Attempt to get client Id from variable to keep it constant.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // See details in section-9 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Duid = GetVariable (L"ClientId", &gEfiDhcp6ServiceBindingProtocolGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of client identifier option:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | OPTION_CLIENTID | option-len |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // . DUID .
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // . (variable length) .
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If System UUID is found from SMBIOS Table, use DUID-UUID type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of DUID-UUID:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | DUID-Type (4) | UUID (128 bits) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // sizeof (option-len + Duid-type + UUID-size) = 20 bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Duid = AllocateZeroPool (2 + 2 + sizeof (EFI_GUID));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // sizeof (Duid-type + UUID-size) = 18 bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set the Duid-type and copy UUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 ((UINT16 *) (Duid->Duid), HTONS (Dhcp6DuidTypeUuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of DUID-LLT:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | Duid type (1) | hardware type (16 bits) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | time (32 bits) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // . link-layer address (variable length) .
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Generate a time stamp of the seconds from 2000/1/1, assume 30day/month.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((((Time.Year - 2000) * 360 + (Time.Month - 1)) * 30 + (Time.Day - 1)) * 24 + Time.Hour) * 60 + Time.Minute) *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // sizeof (option-len + Duid-type + hardware-type + time) = 10 bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Duid = AllocateZeroPool (10 + Mode->HwAddressSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // sizeof (Duid-type + hardware-type + time) = 8 bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set the Duid-type, hardware-type, time and copy the hardware address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 ((UINT16 *) (Duid->Duid), HTONS (Dhcp6DuidTypeLlt));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 ((UINT16 *) (Duid->Duid + 2), HTONS (NET_IFTYPE_ETHERNET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned32 ((UINT32 *) (Duid->Duid + 4), HTONL (Stamp));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (Duid->Duid + 8, &Mode->CurrentAddress, Mode->HwAddressSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"ClientId",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copy the Dhcp6 configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DstCfg The pointer to the destination configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SorCfg The pointer to the source configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Copy the content from SorCfg from DstCfg successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (DstCfg, SorCfg, sizeof (EFI_DHCP6_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate another buffer for solicitretransmission, and copy it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DstCfg->SolicitRetransmission = AllocateZeroPool (sizeof (EFI_DHCP6_RETRANSMISSION));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Error will be handled out of this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (SorCfg->OptionList != NULL && SorCfg->OptionCount != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionListSize = SorCfg->OptionCount * sizeof (EFI_DHCP6_PACKET_OPTION *);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DstCfg->OptionList = AllocateZeroPool (OptionListSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Error will be handled out of this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < SorCfg->OptionCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionSize = NTOHS (SorCfg->OptionList[Index]->OpLen) + 4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DstCfg->OptionList[Index] = AllocateZeroPool (OptionSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Error will be handled out of this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Clean up the configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] CfgData The pointer to the configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clean up all fields in config data including the reference buffers, but do
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // not free the config data buffer itself.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < CfgData->OptionCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Clean up the mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] ModeData The pointer to the mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clean up all fields in mode data including the reference buffers, but do
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // not free the mode data buffer itself.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calculate the expire time by the algorithm defined in rfc.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Base The base value of the time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IsFirstRt If TRUE, it is the first time to calculate expire time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NeedSigned If TRUE, the the signed factor is needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Expire The calculated result for the new expire time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Take the 10bits of microsecond in system time as a uniform distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Take the 10th bit as a flag to determine it's signed or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Seed = ((Time.Nanosecond >> 10) & DHCP6_10_BIT_MASK);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Signed = (BOOLEAN) ((((Time.Nanosecond >> 9) & 0x01) != 0) ? TRUE : FALSE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Calculate expire by the following algo:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 1. base + base * (-0.1 ~ 0) for the first solicit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 2. base + base * (-0.1 ~ 0.1) for the first other messages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 3. 2 * base + base * (-0.1 ~ 0.1) for the subsequent all messages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 4. base + base * (-0.1 ~ 0) for the more than mrt timeout
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The (Seed / 0x3ff / 10) is used to a random range (0, 0.1).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Expire = Base - (UINT32) (Base * Seed / DHCP6_10_BIT_MASK / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Expire = Base + (UINT32) (Base * Seed / DHCP6_10_BIT_MASK / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Expire = 2 * Base - (UINT32) (Base * Seed / DHCP6_10_BIT_MASK / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Expire = 2 * Base + (UINT32) (Base * Seed / DHCP6_10_BIT_MASK / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calculate the lease time by the algorithm defined in rfc.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaCb The pointer to the Ia control block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Calculate minlt as min of all valid life time, and maxlt as max of all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // valid life time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < IaCb->Ia->IaAddressCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaAddr = IaCb->Ia->IaAddress + Index * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Take 50% minlt as t1, and 80% maxlt as t2 if Dhcp6 server doesn't offer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // such information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaCb->T1 = (IaCb->T1 != 0) ? IaCb->T1 : (UINT32)(MinLt * 5 / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaCb->T2 = (IaCb->T2 != 0) ? IaCb->T2 : (UINT32)(MinLt * 8 / 10);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the addresses are all included by the configured Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ia The pointer to the Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AddressCount The number of addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Addresses The pointer to the addresses buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The addresses are all included by the configured IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The addresses are not included by the configured IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether the addresses are all included by the configured IA. And it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // will return success if address count is zero, which means all addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index1 = 0; Index1 < AddressCount; Index1++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index2 = 0; Index2 < Ia->IaAddressCount; Index2++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deprive the addresses from current Ia, and generate another eliminated Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ia The pointer to the Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AddressCount The number of addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Addresses The pointer to the addresses buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If it failed to generate the deprived Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval others The pointer to the deprived Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // It means release all Ia addresses if address count is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaCopySize = sizeof (EFI_DHCP6_IA) + (AddressCount - 1) * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If release all Ia addresses, just copy the configured Ia and then set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // its address count as zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We may decline/release part of addresses at the begining. So it's a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // forwarding step to update address infor for decline/release, while the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // other infor such as Ia state will be updated when receiving reply.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Move the addresses from the Ia of instance to the deprived Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index1 = 0; Index1 < AddressCount; Index1++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index2 = 0; Index2 < Ia->IaAddressCount; Index2++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the deprived address to the copy of Ia
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Delete the deprived address from the instance Ia
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (Ia->IaAddressCount - Index2 - 1) * sizeof (EFI_DHCP6_IA_ADDRESS)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The dummy ext buffer free callback routine.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Arg The pointer to the parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The callback routine once message transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Wrap The pointer to the received net buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EndPoint The pointer to the udp end point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The return status from udp io.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque parameter to the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Append the option to Buf, and move Buf to the end.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buf The pointer to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptType The option type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptLen The length of option contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data The pointer to the option content.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Buf The position to append the next option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of Dhcp6 option:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | option-code | option-len (option data) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | option-data |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | (option-len octets) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Append the appointed Ia option to Buf, and move Buf to the end.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buf The pointer to the position to append.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ia The pointer to the Ia.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] T1 The time of T1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] T2 The time of T2.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Buf The position to append the next Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of IA_NA and IA_TA option:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | OPTION_IA_NA | option-len |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | IAID (4 octets) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | T1 (only for IA_NA) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | T2 (only for IA_NA) |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the value of Ia option type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 ((UINT16 *) Buf, HTONS (Ia->Descriptor.Type));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the len of Ia option later, keep the pointer first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the value of iaid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned32 ((UINT32 *) Buf, HTONL (Ia->Descriptor.IaId));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the value of t1 and t2 if iana, keep it 0xffffffff if no specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned32 ((UINT32 *) Buf, ((T1 != 0) ? T1 : 0xffffffff));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned32 ((UINT32 *) Buf, ((T2 != 0) ? T2 : 0xffffffff));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill all the addresses belong to the Ia
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < Ia->IaAddressCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AddrOpt = (UINT8 *) Ia->IaAddress + Index * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = HTONS ((UINT16) sizeof (EFI_DHCP6_IA_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the value of Ia option length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Append the appointed Elapsed time option to Buf, and move Buf to the end.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buf The pointer to the position to append.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Instance The pointer to the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Elapsed The pointer to the elapsed time value in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the generated packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Buf The position to append the next Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of elapsed time option:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | OPTION_ELAPSED_TIME | option-len |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | elapsed-time |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the value of elapsed-time option type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 ((UINT16 *) Buf, HTONS (Dhcp6OptElapsedTime));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the len of elapsed-time option, which is fixed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill in elapsed time value with 0 value for now. The actual value is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // filled in later just before the packet is transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the elapsed time based on the given instance and the pointer to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync elapsed time option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Elapsed The pointer to the position to append.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Instance The pointer to the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Generate a time stamp of the centiseconds from 2000/1/1, assume 30day/month.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Sentinel value of 0 means that this is the first DHCP packet that we are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // sending and that we need to initialize the value. First DHCP Solicit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // gets 0 elapsed-time. Otherwise, calculate based on StartTime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ElapsedTimeValue = CurrentStamp - Instance->StartTime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If elapsed time cannot fit in two bytes, set it to 0xffff.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WriteUnaligned16 (Elapsed, HTONS((UINT16) ElapsedTimeValue));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Seek the address of the first byte of the option header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buf The pointer to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SeekLen The length to seek.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptType The option type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If it failed to seek the option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval others The position to the option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of Dhcp6 option refers to Dhcp6AppendOption().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataLen = NTOHS (ReadUnaligned16 ((UINT16 *) (Cursor + 2)));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Seek the address of the first byte of the Ia option header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buf The pointer to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SeekLen The length to seek.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaDesc The pointer to the Ia descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If it failed to seek the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval others The position to the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of IA_NA and IA_TA option refers to Dhcp6AppendIaOption().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (OpCode == HTONS (IaDesc->Type) && IaId == HTONL (IaDesc->IaId)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataLen = NTOHS (ReadUnaligned16 ((UINT16 *) (Cursor + 2)));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parse the address option and update the address infomation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaInnerOpt The pointer to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaInnerLen The length to parse.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AddrNum The number of addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] AddrBuf The pointer to the address buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The format of the IA Address option:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | OPTION_IAADDR | option-len |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | IPv6 address |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | preferred-lifetime |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // | valid-lifetime |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // . IAaddr-options .
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Two usage model:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 1. Pass addrbuf == null, to get the addrnum over the Ia inner options.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 2. Pass addrbuf != null, to resolve the addresses over the Ia inner
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // options to the addrbuf.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Count the Ia address option with non-0 valid time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ValidLt = ReadUnaligned32 ((UINT32 *) (Cursor + 24));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (OpCode == HTONS (Dhcp6OptIaAddr) && ValidLt != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (AddrBuf, Cursor + 4, sizeof (EFI_DHCP6_IA_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AddrBuf->PreferredLifetime = NTOHL (AddrBuf->PreferredLifetime);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AddrBuf->ValidLifetime = NTOHL (AddrBuf->ValidLifetime);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AddrBuf = (EFI_DHCP6_IA_ADDRESS *) ((UINT8 *) AddrBuf + sizeof (EFI_DHCP6_IA_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataLen = NTOHS (ReadUnaligned16 ((UINT16 *) (Cursor + 2)));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a control blcok for the Ia according to the corresponding options.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Instance The pointer to DHCP6 Instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaInnerOpt The pointer to the inner options in the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IaInnerLen The length of all the inner options in the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] T1 T1 time in the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] T2 T2 time in the Ia option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No valid IA option is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Create an IA control block successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Calculate the number of addresses for this Ia, excluding the addresses with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the value 0 of valid lifetime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6ParseAddrOption (IaInnerOpt, IaInnerLen, &AddrNum, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate for new IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaSize = sizeof (EFI_DHCP6_IA) + (AddrNum - 1) * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill up this new IA fields.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Ia->Descriptor, &Instance->Config->IaDescriptor, sizeof (EFI_DHCP6_IA_DESCRIPTOR));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6ParseAddrOption (IaInnerOpt, IaInnerLen, &AddrNum, Ia->IaAddress);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Free original IA resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update IaCb to use new IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill in IaCb fields. Such as T1, T2, AllExpireTime and LeaseTime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cache the current IA configuration information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Instance The pointer to DHCP6 Instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Cache the current IA successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Cache the current IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaSize = sizeof (EFI_DHCP6_IA) + (Ia->IaAddressCount - 1) * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Instance The pointer to DHCP6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CacheIa != NULL) && (CacheIa->IaAddressCount != 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There are old addresses existing. Merge with current addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewIaSize = sizeof (EFI_DHCP6_IA) + (Ia->IaAddressCount + CacheIa->IaAddressCount - 1) * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IaSize = sizeof (EFI_DHCP6_IA) + (Ia->IaAddressCount - 1) * sizeof (EFI_DHCP6_IA_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clear old address.ValidLifetime
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < CacheIa->IaAddressCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ptr = (UINT8*)&NewIa->IaAddress[Ia->IaAddressCount];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (Ptr, CacheIa->IaAddress, CacheIa->IaAddressCount * sizeof (EFI_DHCP6_IA_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Migrate to the NewIa and free previous.