iPXE
efi_cachedhcp.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <string.h>
27 #include <errno.h>
28 #include <ipxe/cachedhcp.h>
29 #include <ipxe/efi/efi.h>
30 #include <ipxe/efi/efi_path.h>
31 #include <ipxe/efi/efi_cachedhcp.h>
33 
34 /** @file
35  *
36  * EFI cached DHCP packet
37  *
38  */
39 
40 /**
41  * Record cached DHCP packet
42  *
43  * @v device Device handle
44  * @v path Device path
45  * @ret rc Return status code
46  */
48  EFI_DEVICE_PATH_PROTOCOL *path ) {
50  unsigned int vlan;
51  union {
53  void *interface;
54  } pxe;
56  EFI_STATUS efirc;
57  int rc;
58 
59  /* Get VLAN tag, if any */
60  vlan = efi_path_vlan ( path );
61 
62  /* Look for a PXE base code instance on the image's device handle */
63  if ( ( efirc = bs->OpenProtocol ( device,
65  &pxe.interface, efi_image_handle,
66  NULL,
68  rc = -EEFI ( efirc );
69  DBGC ( device, "EFI %s has no PXE base code instance: %s\n",
70  efi_handle_name ( device ), strerror ( rc ) );
71  goto err_open;
72  }
73 
74  /* Do not attempt to cache IPv6 packets */
75  mode = pxe.pxe->Mode;
76  if ( mode->UsingIpv6 ) {
77  rc = -ENOTSUP;
78  DBGC ( device, "EFI %s has IPv6 PXE base code\n",
79  efi_handle_name ( device ) );
80  goto err_ipv6;
81  }
82 
83  /* Record DHCPACK, if present */
84  if ( mode->DhcpAckReceived &&
85  ( ( rc = cachedhcp_record ( &cached_dhcpack, vlan,
86  virt_to_user ( &mode->DhcpAck ),
87  sizeof ( mode->DhcpAck ) ) ) != 0 ) ) {
88  DBGC ( device, "EFI %s could not record DHCPACK: %s\n",
89  efi_handle_name ( device ), strerror ( rc ) );
90  goto err_dhcpack;
91  }
92 
93  /* Record ProxyDHCPOFFER, if present */
94  if ( mode->ProxyOfferReceived &&
95  ( ( rc = cachedhcp_record ( &cached_proxydhcp, vlan,
96  virt_to_user ( &mode->ProxyOffer ),
97  sizeof ( mode->ProxyOffer ) ) ) != 0)){
98  DBGC ( device, "EFI %s could not record ProxyDHCPOFFER: %s\n",
99  efi_handle_name ( device ), strerror ( rc ) );
100  goto err_proxydhcp;
101  }
102 
103  /* Record PxeBSACK, if present */
104  if ( mode->PxeReplyReceived &&
105  ( ( rc = cachedhcp_record ( &cached_pxebs, vlan,
106  virt_to_user ( &mode->PxeReply ),
107  sizeof ( mode->PxeReply ) ) ) != 0)){
108  DBGC ( device, "EFI %s could not record PXEBSACK: %s\n",
109  efi_handle_name ( device ), strerror ( rc ) );
110  goto err_pxebs;
111  }
112 
113  /* Success */
114  rc = 0;
115 
116  err_pxebs:
117  err_proxydhcp:
118  err_dhcpack:
119  err_ipv6:
122  err_open:
123  return rc;
124 }
EFI_PXE_BASE_CODE_MODE.
Definition: PxeBaseCode.h:271
EFI_BOOT_SERVICES * BootServices
A pointer to the EFI Boot Services Table.
Definition: UefiSpec.h:2081
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
unsigned int efi_path_vlan(EFI_DEVICE_PATH_PROTOCOL *path)
Get VLAN tag from device path.
Definition: efi_path.c:180
#define EEFI(efirc)
Convert an EFI status code to an iPXE status code.
Definition: efi.h:171
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
Error codes.
struct cached_dhcp_packet cached_proxydhcp
Cached ProxyDHCPOFFER.
Definition: cachedhcp.c:57
#define DBGC(...)
Definition: compiler.h:505
EFI_GUID efi_pxe_base_code_protocol_guid
PXE base code protocol GUID.
Definition: efi_guid.c:291
EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible devices for network ac...
This protocol can be used on any device handle to obtain generic path/location information concerning...
Definition: DevicePath.h:45
EFI_PXE_BASE_CODE_PACKET PxeReply
Definition: PxeBaseCode.h:297
EFI_CLOSE_PROTOCOL CloseProtocol
Definition: UefiSpec.h:1987
#define ENOTSUP
Operation not supported.
Definition: errno.h:589
A hardware device.
Definition: device.h:73
An object interface.
Definition: interface.h:124
Cached DHCP packet.
#define EFI_OPEN_PROTOCOL_GET_PROTOCOL
Definition: UefiSpec.h:1344
const char * efi_handle_name(EFI_HANDLE handle)
Get name of an EFI handle.
Definition: efi_debug.c:808
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
EFI cached DHCP packet.
EFI Boot Services Table.
Definition: UefiSpec.h:1917
EFI_HANDLE efi_image_handle
Image handle passed to entry point.
Definition: efi_init.c:34
int cachedhcp_record(struct cached_dhcp_packet *cache, unsigned int vlan, userptr_t data, size_t max_len)
Record cached DHCP packet.
Definition: cachedhcp.c:187
EFI device paths.
struct cached_dhcp_packet cached_dhcpack
Cached DHCPACK.
Definition: cachedhcp.c:52
EFI API.
int efi_cachedhcp_record(EFI_HANDLE device, EFI_DEVICE_PATH_PROTOCOL *path)
Record cached DHCP packet.
Definition: efi_cachedhcp.c:47
EFI_PXE_BASE_CODE_PACKET DhcpAck
Definition: PxeBaseCode.h:294
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
userptr_t virt_to_user(volatile const void *addr)
Convert virtual address to user pointer.
EFI_SYSTEM_TABLE * efi_systab
EFI_OPEN_PROTOCOL OpenProtocol
Definition: UefiSpec.h:1986
struct cached_dhcp_packet cached_pxebs
Cached PXEBSACK.
Definition: cachedhcp.c:62
The EFI_PXE_BASE_CODE_PROTOCOL is used to control PXE-compatible devices.
Definition: PxeBaseCode.h:908
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
EFI_PXE_BASE_CODE_PACKET ProxyOffer
Definition: PxeBaseCode.h:295
String functions.
Definition: efi.h:59