iPXE
Functions
iobuf.c File Reference

I/O buffers. More...

#include <stdint.h>
#include <strings.h>
#include <errno.h>
#include <ipxe/malloc.h>
#include <ipxe/iobuf.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
struct io_bufferalloc_iob_raw (size_t len, size_t align, size_t offset)
 Allocate I/O buffer with specified alignment and offset. More...
 
struct io_bufferalloc_iob (size_t len)
 Allocate I/O buffer. More...
 
void free_iob (struct io_buffer *iobuf)
 Free I/O buffer. More...
 
int iob_ensure_headroom (struct io_buffer *iobuf, size_t len)
 Ensure I/O buffer has sufficient headroom. More...
 
struct io_bufferiob_concatenate (struct list_head *list)
 Concatenate I/O buffers into a single buffer. More...
 
struct io_bufferiob_split (struct io_buffer *iobuf, size_t len)
 Split I/O buffer. More...
 

Detailed Description

I/O buffers.

Definition in file iobuf.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ alloc_iob_raw()

struct io_buffer* alloc_iob_raw ( size_t  len,
size_t  align,
size_t  offset 
)

Allocate I/O buffer with specified alignment and offset.

Parameters
lenRequired length of buffer
alignPhysical alignment
offsetOffset from physical alignment
Return values
iobufI/O buffer, or NULL if none available

align will be rounded up to the nearest power of two.

Definition at line 48 of file iobuf.c.

48  {
49  struct io_buffer *iobuf;
50  size_t padding;
51  size_t threshold;
52  unsigned int align_log2;
53  void *data;
54 
55  /* Calculate padding required below alignment boundary to
56  * ensure that a correctly aligned inline struct io_buffer
57  * could fit (regardless of the requested offset).
58  */
59  padding = ( sizeof ( *iobuf ) + __alignof__ ( *iobuf ) - 1 );
60 
61  /* Round up requested alignment to at least the size of the
62  * padding, to simplify subsequent calculations.
63  */
64  if ( align < padding )
65  align = padding;
66 
67  /* Round up alignment to the nearest power of two, avoiding
68  * a potentially undefined shift operation.
69  */
70  align_log2 = fls ( align - 1 );
71  if ( align_log2 >= ( 8 * sizeof ( align ) ) )
72  return NULL;
73  align = ( 1UL << align_log2 );
74 
75  /* Calculate length threshold */
76  assert ( align >= padding );
77  threshold = ( align - padding );
78 
79  /* Allocate buffer plus an inline descriptor as a single unit,
80  * unless doing so would push the total size over the
81  * alignment boundary.
82  */
83  if ( len <= threshold ) {
84 
85  /* Round up buffer length to ensure that struct
86  * io_buffer is aligned.
87  */
88  len += ( ( - len - offset ) & ( __alignof__ ( *iobuf ) - 1 ) );
89 
90  /* Allocate memory for buffer plus descriptor */
91  data = malloc_dma_offset ( len + sizeof ( *iobuf ), align,
92  offset );
93  if ( ! data )
94  return NULL;
95  iobuf = ( data + len );
96 
97  } else {
98 
99  /* Allocate memory for buffer */
100  data = malloc_dma_offset ( len, align, offset );
101  if ( ! data )
102  return NULL;
103 
104  /* Allocate memory for descriptor */
105  iobuf = malloc ( sizeof ( *iobuf ) );
106  if ( ! iobuf ) {
107  free_dma ( data, len );
108  return NULL;
109  }
110  }
111 
112  /* Populate descriptor */
113  iobuf->head = iobuf->data = iobuf->tail = data;
114  iobuf->end = ( data + len );
115 
116  return iobuf;
117 }
static void *__malloc malloc_dma_offset(size_t size, size_t phys_align, size_t offset)
Allocate memory for DMA.
Definition: malloc.h:46
void * tail
End of data.
Definition: iobuf.h:46
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
static userptr_t size_t offset
Offset of the first segment within the content.
Definition: deflate.h:259
void * end
End of the buffer.
Definition: iobuf.h:48
void * malloc(size_t size)
Allocate memory.
Definition: malloc.c:583
uint32_t len
Length.
Definition: ena.h:14
void * head
Start of the buffer.
Definition: iobuf.h:42
void * data
Start of data.
Definition: iobuf.h:44
struct arbelprm_port_state_change_st data
Message.
Definition: arbel.h:12
#define fls(x)
Find last (i.e.
Definition: strings.h:166
static void free_dma(void *ptr, size_t size)
Free memory allocated with malloc_dma()
Definition: malloc.h:81
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A persistent I/O buffer.
Definition: iobuf.h:32

References assert(), data, io_buffer::data, io_buffer::end, fls, free_dma(), io_buffer::head, len, malloc(), malloc_dma_offset(), NULL, offset, and io_buffer::tail.

Referenced by alloc_iob(), alloc_iob_fail_okx(), alloc_iob_okx(), ath_rx_init(), ath_rx_tasklet(), iob_concatenate(), ipoib_alloc_iob(), and tls_newdata_process_header().

◆ alloc_iob()

struct io_buffer* alloc_iob ( size_t  len)

Allocate I/O buffer.

Parameters
lenRequired length of buffer
Return values
iobufI/O buffer, or NULL if none available

The I/O buffer will be physically aligned on its own size (rounded up to the nearest power of two).

Definition at line 128 of file iobuf.c.

128  {
129 
130  /* Pad to minimum length */
131  if ( len < IOB_ZLEN )
132  len = IOB_ZLEN;
133 
134  /* Align buffer on its own size to avoid potential problems
135  * with boundary-crossing DMA.
136  */
137  return alloc_iob_raw ( len, len, 0 );
138 }
struct io_buffer * alloc_iob_raw(size_t len, size_t align, size_t offset)
Allocate I/O buffer with specified alignment and offset.
Definition: iobuf.c:48
uint32_t len
Length.
Definition: ena.h:14
#define IOB_ZLEN
Minimum I/O buffer length.
Definition: iobuf.h:23

References alloc_iob_raw(), IOB_ZLEN, and len.

Referenced by a3c90x_refill_rx_ring(), acm_control_receive(), aoecmd_tx(), arp_tx_request(), ath5k_rx_iob_alloc(), atl1e_clean_rx_irq(), axge_in_complete(), b44_init_rx_ring(), b44_rx_refill(), ccmp_decrypt(), ccmp_encrypt(), efab_fill_rx_queue(), efi_snp_transmit(), efi_usb_sync_transfer(), efx_hunt_rxq_fill(), ena_refill_rx(), eoib_duplicate(), exanic_poll_rx(), fcoe_alloc_iob(), fcoe_fip_tx_keepalive(), fcoe_fip_tx_solicitation(), fcoe_fip_tx_vlan(), fragment_reassemble(), gdbudp_send(), http_rx_chunk_data(), http_tx_request(), hunt_mcdi_init(), ib_mi_send(), icplus_refill_rx(), ifec_get_rx_desc(), igbvf_refill_rx_ring(), igbvf_setup_rx_resources(), intel_refill_rx(), intelxl_refill_rx(), iob_split(), jme_make_new_rx_buf(), legacy_poll(), loopback_test(), myri10ge_net_open(), myri10ge_net_poll(), myson_refill_rx(), natsemi_refill_rx(), ncm_in_complete(), ndp_tx_ll_addr(), net80211_accum_frags(), net80211_probe_start(), net80211_probe_step(), net80211_send_assoc(), net80211_send_auth(), net80211_send_disassoc(), netfront_refill_rx(), nii_poll_rx(), nv_alloc_rx(), oncrpc_call(), pcnet32_refill_rx_ring(), phantom_refill_rx_ring(), ping_alloc_iob(), pnic_poll(), pxenv_undi_transmit(), realtek_legacy_poll_rx(), realtek_refill_rx(), rhine_refill_rx(), rndis_alloc_iob(), rtl818x_handle_rx(), rtl818x_init_rx_ring(), sis190_alloc_rx_iob(), skge_rx_refill(), sky2_rx_alloc(), snpnet_poll_rx(), tcp_xmit_reset(), tcp_xmit_sack(), tg3_alloc_rx_iob(), tkip_decrypt(), tkip_encrypt(), txnic_refill_rq(), udp_xfer_alloc_iob(), undinet_poll(), usb_control(), usb_prefill(), usb_refill(), velocity_refill_rx(), virtnet_refill_rx_virtqueue(), vmbus_xfer_page_iobufs(), vmxnet3_refill_rx(), vxge_hw_ring_replenish(), vxge_hw_vpath_poll_rx(), wep_decrypt(), wep_encrypt(), wpa_alloc_frame(), and xfer_alloc_iob().

◆ free_iob()

void free_iob ( struct io_buffer iobuf)

Free I/O buffer.

Parameters
iobufI/O buffer

Definition at line 145 of file iobuf.c.

145  {
146  size_t len;
147 
148  /* Allow free_iob(NULL) to be valid */
149  if ( ! iobuf )
150  return;
151 
152  /* Sanity checks */
153  assert ( iobuf->head <= iobuf->data );
154  assert ( iobuf->data <= iobuf->tail );
155  assert ( iobuf->tail <= iobuf->end );
156 
157  /* Free buffer */
158  len = ( iobuf->end - iobuf->head );
159  if ( iobuf->end == iobuf ) {
160 
161  /* Descriptor is inline */
162  free_dma ( iobuf->head, ( len + sizeof ( *iobuf ) ) );
163 
164  } else {
165 
166  /* Descriptor is detached */
167  free_dma ( iobuf->head, len );
168  free ( iobuf );
169  }
170 }
void * tail
End of data.
Definition: iobuf.h:46
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:54
void * end
End of the buffer.
Definition: iobuf.h:48
uint32_t len
Length.
Definition: ena.h:14
void * head
Start of the buffer.
Definition: iobuf.h:42
void * data
Start of data.
Definition: iobuf.h:44
static void free_dma(void *ptr, size_t size)
Free memory allocated with malloc_dma()
Definition: malloc.h:81

References assert(), io_buffer::data, io_buffer::end, free, free_dma(), io_buffer::head, len, and io_buffer::tail.

Referenced by __vxge_hw_ring_delete(), a3c90x_free_rx_iobuf(), acm_control_receive(), acm_in_complete(), acm_intr_complete(), alloc_iob_okx(), aoe_rx(), aoecmd_rx(), arp_rx(), ath5k_rxbuf_free(), ath9k_stop(), ath9k_tx(), ath_rx_cleanup(), axge_in_complete(), axge_intr_complete(), b44_free_rx_ring(), b44_rx_refill(), ccmp_decrypt(), dhcp_deliver(), dhcp_tx(), dhcpv6_rx(), dm96xx_in_complete(), dm96xx_intr_complete(), dns_xfer_deliver(), eapol_key_rx(), eapol_rx(), ecm_in_complete(), ecm_intr_complete(), efab_free_resources(), efab_receive(), efi_download_deliver_iob(), efi_local_step(), efi_pxe_udp_close(), efi_pxe_udp_deliver(), efi_pxe_udp_read(), efi_pxe_udp_write(), efi_snp_flush(), efi_snp_receive(), efi_snp_transmit(), efi_usb_sync_transfer(), efx_hunt_close(), ena_empty_rx(), eoib_heartbeat_rx(), eth_slow_marker_rx(), eth_slow_rx(), fc_els_rx(), fc_ns_query_deliver(), fc_port_deliver(), fc_xchg_rx(), fc_xchg_tx(), fcoe_deliver(), fcoe_fip_rx(), fcoe_rx(), fcpcmd_recv_rddata(), fcpcmd_recv_rsp(), fcpcmd_recv_unknown(), fcpcmd_recv_xfer_rdy(), fragment_expired(), fragment_reassemble(), free_tls(), ftp_control_deliver(), gdbudp_recv(), http_conn_deliver(), http_content_deliver(), http_tx_request(), hunt_mcdi_fini(), ib_cmrc_complete_recv(), ib_cmrc_complete_send(), ib_cmrc_xfer_deliver(), ib_complete_recv(), ib_complete_send(), ib_mi_complete_recv(), ib_mi_send(), ib_refill_recv(), icmp_rx_echo_reply(), icmp_rx_echo_request(), icmp_tx_echo_request(), icmpv4_rx(), icmpv6_rx(), icplus_close(), ifec_free(), igbvf_free_rx_resources(), intel_empty_rx(), intelxl_empty_rx(), iob_concatenate(), ipv4_rx(), ipv4_tx(), ipv6_rx(), ipv6_tx(), iscsi_socket_deliver(), jme_free_rx_buf(), legacy_poll(), loopback_wait(), lotest_flush(), lotest_rx(), myri10ge_net_close(), myri10ge_net_open(), myson_close(), natsemi_close(), ncm_intr_complete(), ndp_rx_neighbour(), ndp_rx_router_advertisement(), net80211_free_frags(), net80211_free_wlan(), net80211_handle_mgmt(), net80211_probe_finish_all(), net80211_probe_finish_best(), net80211_probe_step(), net80211_rx(), net80211_rx_frag(), net80211_tx_mgmt(), net_discard(), net_poll(), net_rx(), netdev_rx_err(), netdev_tx_err(), netfront_close(), netvsc_recv_data(), nfs_deliver(), nfs_mount_deliver(), nfs_pm_deliver(), nii_close(), ntp_deliver(), nv_free_rxtx_resources(), pcnet32_free_rx_resources(), peerblk_deliver(), peerblk_raw_rx(), peerblk_retrieval_rx(), peerdisc_socket_rx(), phantom_close(), ping_rx(), pinger_deliver(), posix_file_free(), posix_file_xfer_deliver(), pxe_tftp_xfer_deliver(), pxe_udp_deliver(), pxenv_udp_close(), pxenv_udp_read(), pxenv_undi_isr(), pxenv_undi_transmit(), rarp_rx(), read_user(), realtek_close(), rhine_close(), rndis_rx_initialise(), rndis_rx_query_oid(), rndis_rx_set_oid(), rndis_rx_status(), rndis_tx_complete_err(), rndis_tx_halt(), rndis_tx_initialise(), rndis_tx_oid(), rtl818x_free_rx_ring(), sis190_free(), skge_rx_clean(), sky2_rx_clean(), slam_mc_socket_deliver(), slam_socket_deliver(), slam_tx_nack(), smsc75xx_in_complete(), smsc95xx_in_complete(), smscusb_intr_complete(), snpnet_close(), srpdev_deliver(), stp_rx(), tcp_close(), tcp_discard(), tcp_process_tx_queue(), tcp_rx(), tcp_rx_data(), tcp_rx_enqueue(), tcpip_rx(), tcpip_tx(), tftp_rx(), tftp_rx_data(), tg3_rx_iob_free(), tkip_decrypt(), tls_cipherstream_deliver(), tls_new_record(), tls_newdata_process_header(), tls_plainstream_deliver(), tls_send_plaintext(), txnic_destroy_rq(), udp_rx(), udp_tx(), unregister_usb(), usb_control(), usb_flush(), velocity_close(), virtnet_close(), vlan_rx(), vmbus_xfer_page_iobufs(), vxge_hw_ring_replenish(), wep_decrypt(), xcm_deliver(), xfer_deliver(), and xferbuf_deliver().

◆ iob_ensure_headroom()

int iob_ensure_headroom ( struct io_buffer iobuf,
size_t  len 
)

Ensure I/O buffer has sufficient headroom.

Parameters
iobufI/O buffer
lenRequired headroom

This function currently only checks for the required headroom; it does not reallocate the I/O buffer if required. If we ever have a code path that requires this functionality, it's a fairly trivial change to make.

Definition at line 183 of file iobuf.c.

183  {
184 
185  if ( iob_headroom ( iobuf ) >= len )
186  return 0;
187  return -ENOBUFS;
188 }
static size_t iob_headroom(struct io_buffer *iobuf)
Calculate available space at start of an I/O buffer.
Definition: iobuf.h:161
uint32_t len
Length.
Definition: ena.h:14
#define ENOBUFS
No buffer space available.
Definition: errno.h:498

References ENOBUFS, iob_headroom(), and len.

Referenced by axge_out_transmit(), dm96xx_out_transmit(), efi_pxe_udp_deliver(), ncm_out_transmit(), pxe_udp_deliver(), smsc75xx_out_transmit(), smsc95xx_out_transmit(), and udp_tx().

◆ iob_concatenate()

struct io_buffer* iob_concatenate ( struct list_head list)

Concatenate I/O buffers into a single buffer.

Parameters
listList of I/O buffers
Return values
iobufConcatenated I/O buffer, or NULL on allocation failure

After a successful concatenation, the list will be empty.

Definition at line 198 of file iobuf.c.

198  {
199  struct io_buffer *iobuf;
200  struct io_buffer *tmp;
201  struct io_buffer *concatenated;
202  size_t len = 0;
203 
204  /* If the list contains only a single entry, avoid an
205  * unnecessary additional allocation.
206  */
207  if ( list_is_singular ( list ) ) {
208  iobuf = list_first_entry ( list, struct io_buffer, list );
209  INIT_LIST_HEAD ( list );
210  return iobuf;
211  }
212 
213  /* Calculate total length */
214  list_for_each_entry ( iobuf, list, list )
215  len += iob_len ( iobuf );
216 
217  /* Allocate new I/O buffer */
218  concatenated = alloc_iob_raw ( len, __alignof__ ( *iobuf ), 0 );
219  if ( ! concatenated )
220  return NULL;
221 
222  /* Move data to new I/O buffer */
223  list_for_each_entry_safe ( iobuf, tmp, list, list ) {
224  list_del ( &iobuf->list );
225  memcpy ( iob_put ( concatenated, iob_len ( iobuf ) ),
226  iobuf->data, iob_len ( iobuf ) );
227  free_iob ( iobuf );
228  }
229 
230  return concatenated;
231 }
#define iob_put(iobuf, len)
Definition: iobuf.h:116
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:145
struct io_buffer * alloc_iob_raw(size_t len, size_t align, size_t offset)
Allocate I/O buffer with specified alignment and offset.
Definition: iobuf.c:48
#define list_first_entry(list, type, member)
Get the container of the first entry in a list.
Definition: list.h:333
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
void * memcpy(void *dest, const void *src, size_t len) __nonnull
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:420
#define list_for_each_entry_safe(pos, tmp, head, member)
Iterate over entries in a list, safe against deletion of the current entry.
Definition: list.h:447
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:151
uint8_t * tmp
Definition: entropy.h:156
#define INIT_LIST_HEAD(list)
Initialise a list head.
Definition: list.h:45
#define list_is_singular(list)
Test whether a list has just one entry.
Definition: list.h:149
struct list_head list
List of which this buffer is a member.
Definition: iobuf.h:39
uint32_t len
Length.
Definition: ena.h:14
void * data
Start of data.
Definition: iobuf.h:44
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A persistent I/O buffer.
Definition: iobuf.h:32

References alloc_iob_raw(), io_buffer::data, free_iob(), INIT_LIST_HEAD, iob_len(), iob_put, len, io_buffer::list, list_del, list_first_entry, list_for_each_entry, list_for_each_entry_safe, list_is_singular, memcpy(), NULL, and tmp.

Referenced by tls_new_record().

◆ iob_split()

struct io_buffer* iob_split ( struct io_buffer iobuf,
size_t  len 
)

Split I/O buffer.

Parameters
iobufI/O buffer
lenLength to split into a new I/O buffer
Return values
splitNew I/O buffer, or NULL on allocation failure

Split the first len bytes of the existing I/O buffer into a separate I/O buffer. The resulting buffers are likely to have no headroom or tailroom.

If this call fails, then the original buffer will be unmodified.

Definition at line 246 of file iobuf.c.

246  {
247  struct io_buffer *split;
248 
249  /* Sanity checks */
250  assert ( len <= iob_len ( iobuf ) );
251 
252  /* Allocate new I/O buffer */
253  split = alloc_iob ( len );
254  if ( ! split )
255  return NULL;
256 
257  /* Copy in data */
258  memcpy ( iob_put ( split, len ), iobuf->data, len );
259  iob_pull ( iobuf, len );
260  return split;
261 }
#define iob_pull(iobuf, len)
Definition: iobuf.h:98
#define iob_put(iobuf, len)
Definition: iobuf.h:116
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:128
void * memcpy(void *dest, const void *src, size_t len) __nonnull
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:151
uint32_t len
Length.
Definition: ena.h:14
void * data
Start of data.
Definition: iobuf.h:44
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
A persistent I/O buffer.
Definition: iobuf.h:32

References alloc_iob(), assert(), io_buffer::data, iob_len(), iob_pull, iob_put, len, memcpy(), and NULL.