iPXE
Macros | Functions | Variables
httpconn.c File Reference

Hyper Text Transfer Protocol (HTTP) connection management. More...

#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/tcpip.h>
#include <ipxe/uri.h>
#include <ipxe/timer.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/pool.h>
#include <ipxe/http.h>

Go to the source code of this file.

Macros

#define HTTP_CONN_EXPIRY   ( 10 * TICKS_PER_SEC )
 HTTP pooled connection expiry time. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
 FILE_SECBOOT (PERMITTED)
 
static LIST_HEAD (http_connection_pool)
 HTTP connection pool. More...
 
static struct http_schemehttp_scheme (struct uri *uri)
 Identify HTTP scheme. More...
 
static void http_conn_free (struct refcnt *refcnt)
 Free HTTP connection. More...
 
static void http_conn_close (struct http_connection *conn, int rc)
 Close HTTP connection. More...
 
static void http_conn_expired (struct pooled_connection *pool)
 Disconnect idle HTTP connection. More...
 
static int http_conn_socket_deliver (struct http_connection *conn, struct io_buffer *iobuf, struct xfer_metadata *meta)
 Receive data from transport layer interface. More...
 
static void http_conn_socket_close (struct http_connection *conn, int rc)
 Close HTTP connection transport layer interface. More...
 
static void http_conn_xfer_recycle (struct http_connection *conn)
 Recycle this connection after closing. More...
 
static void http_conn_xfer_close (struct http_connection *conn, int rc)
 Close HTTP connection data transfer interface. More...
 
int http_connect (struct interface *xfer, struct uri *uri)
 Connect to an HTTP server. More...
 

Variables

static struct interface_operation http_conn_socket_operations []
 HTTP connection socket interface operations. More...
 
static struct interface_descriptor http_conn_socket_desc
 HTTP connection socket interface descriptor. More...
 
static struct interface_operation http_conn_xfer_operations []
 HTTP connection data transfer interface operations. More...
 
static struct interface_descriptor http_conn_xfer_desc
 HTTP connection data transfer interface descriptor. More...
 

Detailed Description

Hyper Text Transfer Protocol (HTTP) connection management.

Definition in file httpconn.c.

Macro Definition Documentation

◆ HTTP_CONN_EXPIRY

#define HTTP_CONN_EXPIRY   ( 10 * TICKS_PER_SEC )

HTTP pooled connection expiry time.

Definition at line 48 of file httpconn.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED  )

◆ LIST_HEAD()

static LIST_HEAD ( http_connection_pool  )
static

HTTP connection pool.

◆ http_scheme()

static struct http_scheme* http_scheme ( struct uri uri)
static

Identify HTTP scheme.

Parameters
uriURI
Return values
schemeHTTP scheme, or NULL

Definition at line 59 of file httpconn.c.

59  {
60  struct http_scheme *scheme;
61 
62  /* Sanity check */
63  if ( ! uri->scheme )
64  return NULL;
65 
66  /* Identify scheme */
68  if ( strcasecmp ( uri->scheme, scheme->name ) == 0 )
69  return scheme;
70  }
71 
72  return NULL;
73 }
int strcasecmp(const char *first, const char *second)
Compare case-insensitive strings.
Definition: string.c:209
const char * scheme
Scheme.
Definition: uri.h:69
const char * name
Scheme name (e.g.
Definition: http.h:43
#define for_each_table_entry(pointer, table)
Iterate through all entries within a linker table.
Definition: tables.h:386
#define HTTP_SCHEMES
HTTP scheme table.
Definition: http.h:55
An HTTP URI scheme.
Definition: http.h:41
A Uniform Resource Identifier.
Definition: uri.h:65
#define NULL
NULL pointer (VOID *)
Definition: Base.h:322

References for_each_table_entry, HTTP_SCHEMES, http_scheme::name, NULL, uri::scheme, and strcasecmp().

Referenced by http_connect().

◆ http_conn_free()

static void http_conn_free ( struct refcnt refcnt)
static

Free HTTP connection.

Parameters
refcntReference count

Definition at line 80 of file httpconn.c.

80  {
81  struct http_connection *conn =
83 
84  /* Free connection */
85  uri_put ( conn->uri );
86  free ( conn );
87 }
static void uri_put(struct uri *uri)
Decrement URI reference count.
Definition: uri.h:206
A reference counter.
Definition: refcnt.h:27
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:36
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:55
struct uri * uri
Connection URI.
Definition: http.h:81
An HTTP connection.
Definition: http.h:72

References container_of, free, http_connection::uri, and uri_put().

Referenced by http_connect().

◆ http_conn_close()

static void http_conn_close ( struct http_connection conn,
int  rc 
)
static

Close HTTP connection.

Parameters
connHTTP connection
rcReason for close

Definition at line 95 of file httpconn.c.

95  {
96 
97  /* Remove from connection pool, if applicable */
98  pool_del ( &conn->pool );
99 
100  /* Shut down interfaces */
101  intf_shutdown ( &conn->socket, rc );
102  intf_shutdown ( &conn->xfer, rc );
103  if ( rc == 0 ) {
104  DBGC2 ( conn, "HTTPCONN %p closed %s://%s\n",
105  conn, conn->scheme->name, conn->uri->host );
106  } else {
107  DBGC ( conn, "HTTPCONN %p closed %s://%s: %s\n",
108  conn, conn->scheme->name, conn->uri->host,
109  strerror ( rc ) );
110  }
111 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void intf_shutdown(struct interface *intf, int rc)
Shut down an object interface.
Definition: interface.c:279
#define DBGC(...)
Definition: compiler.h:505
struct interface socket
Transport layer interface.
Definition: http.h:85
void pool_del(struct pooled_connection *pool)
Remove connection from pool.
Definition: pool.c:83
struct interface xfer
Data transfer interface.
Definition: http.h:87
const char * name
Scheme name (e.g.
Definition: http.h:43
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:79
const char * host
Host name.
Definition: uri.h:77
struct http_scheme * scheme
HTTP scheme.
Definition: http.h:83
#define DBGC2(...)
Definition: compiler.h:522
struct uri * uri
Connection URI.
Definition: http.h:81
struct pooled_connection pool
Pooled connection.
Definition: http.h:89

References DBGC, DBGC2, uri::host, intf_shutdown(), http_scheme::name, http_connection::pool, pool_del(), rc, http_connection::scheme, http_connection::socket, strerror(), http_connection::uri, and http_connection::xfer.

Referenced by http_conn_expired(), http_conn_socket_close(), http_conn_xfer_close(), and http_connect().

◆ http_conn_expired()

static void http_conn_expired ( struct pooled_connection pool)
static

Disconnect idle HTTP connection.

Parameters
poolPooled connection

Definition at line 118 of file httpconn.c.

118  {
119  struct http_connection *conn =
120  container_of ( pool, struct http_connection, pool );
121 
122  /* Close connection */
123  http_conn_close ( conn, 0 /* Not an error to close idle connection */ );
124 }
timer_init & pool
Definition: pool.h:66
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:36
static void http_conn_close(struct http_connection *conn, int rc)
Close HTTP connection.
Definition: httpconn.c:95
An HTTP connection.
Definition: http.h:72

References container_of, http_conn_close(), and pool.

Referenced by http_connect().

◆ http_conn_socket_deliver()

static int http_conn_socket_deliver ( struct http_connection conn,
struct io_buffer iobuf,
struct xfer_metadata meta 
)
static

Receive data from transport layer interface.

Parameters
httpHTTP connection
iobufI/O buffer
metaTransfer metadata
Return values
rcReturn status code

Definition at line 134 of file httpconn.c.

136  {
137 
138  /* Mark connection as alive */
139  pool_alive ( &conn->pool );
140 
141  /* Pass on to data transfer interface */
142  return xfer_deliver ( &conn->xfer, iobuf, meta );
143 }
struct interface xfer
Data transfer interface.
Definition: http.h:87
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:195
uint8_t meta
Metadata flags.
Definition: ena.h:14
struct pooled_connection pool
Pooled connection.
Definition: http.h:89

References meta, http_connection::pool, http_connection::xfer, and xfer_deliver().

◆ http_conn_socket_close()

static void http_conn_socket_close ( struct http_connection conn,
int  rc 
)
static

Close HTTP connection transport layer interface.

Parameters
httpHTTP connection
rcReason for close

Definition at line 151 of file httpconn.c.

151  {
152 
153  /* If we are reopenable (i.e. we are a recycled connection
154  * from the connection pool, and we have received no data from
155  * the underlying socket since we were pooled), then suggest
156  * that the client should reopen the connection.
157  */
158  if ( pool_is_reopenable ( &conn->pool ) )
159  pool_reopen ( &conn->xfer );
160 
161  /* Close the connection */
162  http_conn_close ( conn, rc );
163 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
struct interface xfer
Data transfer interface.
Definition: http.h:87
void pool_reopen(struct interface *intf)
Reopen a defunct connection.
Definition: pool.c:52
static void http_conn_close(struct http_connection *conn, int rc)
Close HTTP connection.
Definition: httpconn.c:95
struct pooled_connection pool
Pooled connection.
Definition: http.h:89

References http_conn_close(), http_connection::pool, pool_reopen(), rc, and http_connection::xfer.

◆ http_conn_xfer_recycle()

static void http_conn_xfer_recycle ( struct http_connection conn)
static

Recycle this connection after closing.

Parameters
httpHTTP connection

Definition at line 170 of file httpconn.c.

170  {
171 
172  /* Mark connection as recyclable */
173  pool_recyclable ( &conn->pool );
174  DBGC2 ( conn, "HTTPCONN %p keepalive enabled\n", conn );
175 }
#define DBGC2(...)
Definition: compiler.h:522
struct pooled_connection pool
Pooled connection.
Definition: http.h:89

References DBGC2, and http_connection::pool.

◆ http_conn_xfer_close()

static void http_conn_xfer_close ( struct http_connection conn,
int  rc 
)
static

Close HTTP connection data transfer interface.

Parameters
connHTTP connection
rcReason for close

Definition at line 183 of file httpconn.c.

183  {
184 
185  /* Add to the connection pool if keepalive is enabled and no
186  * error occurred.
187  */
188  if ( ( rc == 0 ) && pool_is_recyclable ( &conn->pool ) ) {
189  intf_restart ( &conn->xfer, rc );
190  pool_add ( &conn->pool, &http_connection_pool,
192  DBGC2 ( conn, "HTTPCONN %p pooled %s://%s\n",
193  conn, conn->scheme->name, conn->uri->host );
194  return;
195  }
196 
197  /* Otherwise, close the connection */
198  http_conn_close ( conn, rc );
199 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
void pool_add(struct pooled_connection *pool, struct list_head *list, unsigned long expiry)
Add connection to pool.
Definition: pool.c:64
void intf_restart(struct interface *intf, int rc)
Shut down and restart an object interface.
Definition: interface.c:344
struct interface xfer
Data transfer interface.
Definition: http.h:87
const char * name
Scheme name (e.g.
Definition: http.h:43
static void http_conn_close(struct http_connection *conn, int rc)
Close HTTP connection.
Definition: httpconn.c:95
const char * host
Host name.
Definition: uri.h:77
struct http_scheme * scheme
HTTP scheme.
Definition: http.h:83
#define HTTP_CONN_EXPIRY
HTTP pooled connection expiry time.
Definition: httpconn.c:48
#define DBGC2(...)
Definition: compiler.h:522
struct uri * uri
Connection URI.
Definition: http.h:81
struct pooled_connection pool
Pooled connection.
Definition: http.h:89

References DBGC2, uri::host, http_conn_close(), HTTP_CONN_EXPIRY, intf_restart(), http_scheme::name, http_connection::pool, pool_add(), rc, http_connection::scheme, http_connection::uri, and http_connection::xfer.

◆ http_connect()

int http_connect ( struct interface xfer,
struct uri uri 
)

Connect to an HTTP server.

Parameters
xferData transfer interface
uriConnection URI
Return values
rcReturn status code

HTTP connections are pooled. The caller should be prepared to receive a pool_reopen() message.

Definition at line 237 of file httpconn.c.

237  {
238  struct http_connection *conn;
239  struct http_scheme *scheme;
240  struct sockaddr_tcpip server;
241  unsigned int port;
242  int rc;
243 
244  /* Identify scheme */
245  scheme = http_scheme ( uri );
246  if ( ! scheme )
247  return -ENOTSUP;
248 
249  /* Sanity check */
250  if ( ! uri->host )
251  return -EINVAL;
252 
253  /* Identify port */
254  port = uri_port ( uri, scheme->port );
255 
256  /* Look for a reusable connection in the pool. Reuse the most
257  * recent connection in order to accommodate authentication
258  * schemes that break the stateless nature of HTTP and rely on
259  * the same connection being reused for authentication
260  * responses.
261  */
262  list_for_each_entry_reverse ( conn, &http_connection_pool, pool.list ) {
263 
264  /* Sanity checks */
265  assert ( conn->uri != NULL );
266  assert ( conn->uri->host != NULL );
267 
268  /* Reuse connection, if possible */
269  if ( ( scheme == conn->scheme ) &&
270  ( strcmp ( uri->host, conn->uri->host ) == 0 ) &&
271  ( port == uri_port ( conn->uri, scheme->port ) ) ) {
272 
273  /* Remove from connection pool, stop timer,
274  * attach to parent interface, and return.
275  */
276  pool_del ( &conn->pool );
277  intf_plug_plug ( &conn->xfer, xfer );
278  DBGC2 ( conn, "HTTPCONN %p reused %s://%s:%d\n", conn,
279  conn->scheme->name, conn->uri->host, port );
280  return 0;
281  }
282  }
283 
284  /* Allocate and initialise structure */
285  conn = zalloc ( sizeof ( *conn ) );
286  if ( ! conn ) {
287  rc = -ENOMEM;
288  goto err_alloc;
289  }
290  ref_init ( &conn->refcnt, http_conn_free );
291  conn->uri = uri_get ( uri );
292  conn->scheme = scheme;
293  intf_init ( &conn->socket, &http_conn_socket_desc, &conn->refcnt );
294  intf_init ( &conn->xfer, &http_conn_xfer_desc, &conn->refcnt );
295  pool_init ( &conn->pool, http_conn_expired, &conn->refcnt );
296 
297  /* Open socket */
298  memset ( &server, 0, sizeof ( server ) );
299  server.st_port = htons ( port );
300  if ( ( rc = xfer_open_named_socket ( &conn->socket, SOCK_STREAM,
301  ( struct sockaddr * ) &server,
302  uri->host, NULL ) ) != 0 )
303  goto err_open;
304 
305  /* Add filter, if any */
306  if ( scheme->filter && ( ( rc = scheme->filter ( conn ) ) != 0 ) )
307  goto err_filter;
308 
309  /* Attach to parent interface, mortalise self, and return */
310  intf_plug_plug ( &conn->xfer, xfer );
311  ref_put ( &conn->refcnt );
312 
313  DBGC2 ( conn, "HTTPCONN %p created %s://%s:%d\n", conn,
314  conn->scheme->name, conn->uri->host, port );
315  return 0;
316 
317  err_filter:
318  err_open:
319  DBGC2 ( conn, "HTTPCONN %p could not create %s://%s:%d: %s\n", conn,
320  conn->scheme->name, conn->uri->host, port, strerror ( rc ) );
321  http_conn_close ( conn, rc );
322  ref_put ( &conn->refcnt );
323  err_alloc:
324  return rc;
325 }
#define EINVAL
Invalid argument.
Definition: errno.h:429
TCP/IP socket address.
Definition: tcpip.h:76
struct refcnt refcnt
Reference count.
Definition: http.h:74
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static struct uri * uri_get(struct uri *uri)
Increment URI reference count.
Definition: uri.h:195
static struct interface_descriptor http_conn_socket_desc
HTTP connection socket interface descriptor.
Definition: httpconn.c:210
timer_init & pool
Definition: pool.h:66
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition: refcnt.h:65
unsigned int port
Default port.
Definition: http.h:45
int(* filter)(struct http_connection *conn)
Transport-layer filter (if any)
Definition: http.h:51
void intf_plug_plug(struct interface *a, struct interface *b)
Plug two object interfaces together.
Definition: interface.c:108
struct interface socket
Transport layer interface.
Definition: http.h:85
void pool_del(struct pooled_connection *pool)
Remove connection from pool.
Definition: pool.c:83
#define ENOTSUP
Operation not supported.
Definition: errno.h:590
struct interface xfer
Data transfer interface.
Definition: http.h:87
#define ENOMEM
Not enough space.
Definition: errno.h:535
u8 port
Port number.
Definition: CIB_PRM.h:31
static struct http_scheme * http_scheme(struct uri *uri)
Identify HTTP scheme.
Definition: httpconn.c:59
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
#define list_for_each_entry_reverse(pos, head, member)
Iterate over entries in a list in reverse order.
Definition: list.h:445
const char * name
Scheme name (e.g.
Definition: http.h:43
Generalized socket address structure.
Definition: socket.h:97
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:79
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:662
static void http_conn_close(struct http_connection *conn, int rc)
Close HTTP connection.
Definition: httpconn.c:95
#define SOCK_STREAM
Definition: socket.h:25
const char * host
Host name.
Definition: uri.h:77
struct http_scheme * scheme
HTTP scheme.
Definition: http.h:83
An HTTP URI scheme.
Definition: http.h:41
#define DBGC2(...)
Definition: compiler.h:522
int strcmp(const char *first, const char *second)
Compare strings.
Definition: string.c:174
struct uri * uri
Connection URI.
Definition: http.h:81
static void http_conn_free(struct refcnt *refcnt)
Free HTTP connection.
Definition: httpconn.c:80
unsigned int uri_port(const struct uri *uri, unsigned int default_port)
Get port from URI.
Definition: uri.c:456
A Uniform Resource Identifier.
Definition: uri.h:65
static void http_conn_expired(struct pooled_connection *pool)
Disconnect idle HTTP connection.
Definition: httpconn.c:118
static void intf_init(struct interface *intf, struct interface_descriptor *desc, struct refcnt *refcnt)
Initialise an object interface.
Definition: interface.h:204
struct pooled_connection pool
Pooled connection.
Definition: http.h:89
#define NULL
NULL pointer (VOID *)
Definition: Base.h:322
An HTTP connection.
Definition: http.h:72
#define htons(value)
Definition: byteswap.h:136
int xfer_open_named_socket(struct interface *xfer, int semantics, struct sockaddr *peer, const char *name, struct sockaddr *local)
Open named socket.
Definition: resolv.c:403
#define ref_put(refcnt)
Drop reference to object.
Definition: refcnt.h:107
void * memset(void *dest, int character, size_t len) __nonnull
static struct interface_descriptor http_conn_xfer_desc
HTTP connection data transfer interface descriptor.
Definition: httpconn.c:223

References assert(), DBGC2, EINVAL, ENOMEM, ENOTSUP, http_scheme::filter, uri::host, htons, http_conn_close(), http_conn_expired(), http_conn_free(), http_conn_socket_desc, http_conn_xfer_desc, http_scheme(), intf_init(), intf_plug_plug(), list_for_each_entry_reverse, memset(), http_scheme::name, NULL, pool, http_connection::pool, pool_del(), port, http_scheme::port, rc, ref_init, ref_put, http_connection::refcnt, http_connection::scheme, SOCK_STREAM, http_connection::socket, sockaddr_tcpip::st_port, strcmp(), strerror(), http_connection::uri, uri_get(), uri_port(), http_connection::xfer, xfer_open_named_socket(), and zalloc().

Referenced by http_open(), and http_reopen().

Variable Documentation

◆ http_conn_socket_operations

struct interface_operation http_conn_socket_operations[]
static
Initial value:
= {
}
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition: interface.c:250
static int http_conn_socket_deliver(struct http_connection *conn, struct io_buffer *iobuf, struct xfer_metadata *meta)
Receive data from transport layer interface.
Definition: httpconn.c:134
static void http_conn_socket_close(struct http_connection *conn, int rc)
Close HTTP connection transport layer interface.
Definition: httpconn.c:151
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:33
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:195
An HTTP connection.
Definition: http.h:72

HTTP connection socket interface operations.

Definition at line 202 of file httpconn.c.

◆ http_conn_socket_desc

struct interface_descriptor http_conn_socket_desc
static
Initial value:
=
static struct interface_operation http_conn_socket_operations[]
HTTP connection socket interface operations.
Definition: httpconn.c:202
#define INTF_DESC_PASSTHRU(object_type, intf, operations, passthru)
Define an object interface descriptor with pass-through interface.
Definition: interface.h:98
An HTTP connection.
Definition: http.h:72

HTTP connection socket interface descriptor.

Definition at line 210 of file httpconn.c.

Referenced by http_connect().

◆ http_conn_xfer_operations

struct interface_operation http_conn_xfer_operations[]
static
Initial value:
= {
}
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition: interface.c:250
static void http_conn_xfer_close(struct http_connection *conn, int rc)
Close HTTP connection data transfer interface.
Definition: httpconn.c:183
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:33
void pool_recycle(struct interface *intf)
Recycle this connection after closing.
Definition: pool.c:42
static void http_conn_xfer_recycle(struct http_connection *conn)
Recycle this connection after closing.
Definition: httpconn.c:170
An HTTP connection.
Definition: http.h:72

HTTP connection data transfer interface operations.

Definition at line 215 of file httpconn.c.

◆ http_conn_xfer_desc

struct interface_descriptor http_conn_xfer_desc
static
Initial value:
=
static struct interface_operation http_conn_xfer_operations[]
HTTP connection data transfer interface operations.
Definition: httpconn.c:215
#define INTF_DESC_PASSTHRU(object_type, intf, operations, passthru)
Define an object interface descriptor with pass-through interface.
Definition: interface.h:98
An HTTP connection.
Definition: http.h:72

HTTP connection data transfer interface descriptor.

Definition at line 223 of file httpconn.c.

Referenced by http_connect().