iPXE
Data Structures | Functions | Variables
ping.c File Reference

ICMP ping protocol. More...

#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/refcnt.h>
#include <ipxe/list.h>
#include <ipxe/iobuf.h>
#include <ipxe/tcpip.h>
#include <ipxe/icmp.h>
#include <ipxe/interface.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/netdevice.h>
#include <ipxe/ping.h>

Go to the source code of this file.

Data Structures

struct  ping_connection
 A ping connection. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static LIST_HEAD (ping_conns)
 List of registered ping connections. More...
 
static struct ping_connectionping_demux (unsigned int port)
 Identify ping connection by local port number. More...
 
static int ping_port_available (int port)
 Check if local port number is available. More...
 
int ping_rx (struct io_buffer *iobuf, struct sockaddr_tcpip *st_src)
 Process ICMP ping reply. More...
 
static struct io_bufferping_alloc_iob (struct ping_connection *ping __unused, size_t len)
 Allocate I/O buffer for ping. More...
 
static int ping_deliver (struct ping_connection *ping, struct io_buffer *iobuf, struct xfer_metadata *meta)
 Deliver datagram as I/O buffer. More...
 
static void ping_close (struct ping_connection *ping, int rc)
 Close ping connection. More...
 
static int ping_open (struct interface *xfer, struct sockaddr *peer, struct sockaddr *local)
 Open a ping connection. More...
 

Variables

static struct interface_operation ping_xfer_operations []
 Ping data transfer interface operations. More...
 
static struct interface_descriptor ping_xfer_desc
 Ping data transfer interface descriptor. More...
 
struct socket_opener ping_ipv4_socket_opener __socket_opener
 Ping IPv4 socket opener. More...
 
int ping_sock_echo = PING_SOCK_ECHO
 Linkage hack. More...
 

Detailed Description

ICMP ping protocol.

Definition in file ping.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ LIST_HEAD()

static LIST_HEAD ( ping_conns  )
static

List of registered ping connections.

◆ ping_demux()

static struct ping_connection* ping_demux ( unsigned int  port)
static

Identify ping connection by local port number.

Parameters
portLocal port number
Return values
pingPing connection, or NULL

Definition at line 75 of file ping.c.

75  {
76  struct ping_connection *ping;
77 
78  list_for_each_entry ( ping, &ping_conns, list ) {
79  if ( ping->port == port )
80  return ping;
81  }
82  return NULL;
83 }
struct list_head list
List of ping connections.
Definition: ping.c:55
A ping connection.
Definition: ping.c:51
u8 port
Port number.
Definition: CIB_PRM.h:31
#define list_for_each_entry(pos, head, member)
Iterate over entries in a list.
Definition: list.h:420
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69

References ping_connection::list, list_for_each_entry, NULL, ping(), and port.

Referenced by ping_port_available(), and ping_rx().

◆ ping_port_available()

static int ping_port_available ( int  port)
static

Check if local port number is available.

Parameters
portLocal port number
Return values
portLocal port number, or negative error

Definition at line 91 of file ping.c.

91  {
92 
93  return ( ping_demux ( port ) ? -EADDRINUSE : port );
94 }
#define EADDRINUSE
Address already in use.
Definition: errno.h:303
static struct ping_connection * ping_demux(unsigned int port)
Identify ping connection by local port number.
Definition: ping.c:75
u8 port
Port number.
Definition: CIB_PRM.h:31

References EADDRINUSE, ping_demux(), and port.

Referenced by ping_open().

◆ ping_rx()

int ping_rx ( struct io_buffer iobuf,
struct sockaddr_tcpip st_src 
)

Process ICMP ping reply.

Parameters
iobufI/O buffer
st_srcSource address
Return values
rcReturn status code

Definition at line 103 of file ping.c.

103  {
104  struct icmp_echo *echo = iobuf->data;
105  struct ping_connection *ping;
106  struct xfer_metadata meta;
107  int rc;
108 
109  /* Sanity check: should already have been checked by ICMP layer */
110  assert ( iob_len ( iobuf ) >= sizeof ( *echo ) );
111 
112  /* Identify connection */
113  ping = ping_demux ( ntohs ( echo->ident ) );
114  DBGC ( ping, "PING %p reply id %#04x seq %#04x\n",
115  ping, ntohs ( echo->ident ), ntohs ( echo->sequence ) );
116  if ( ! ping ) {
117  rc = -ENOTCONN;
118  goto discard;
119  }
120 
121  /* Strip header, construct metadata, and pass data to upper layer */
122  iob_pull ( iobuf, sizeof ( *echo ) );
123  memset ( &meta, 0, sizeof ( meta ) );
124  meta.src = ( ( struct sockaddr * ) st_src );
125  meta.flags = XFER_FL_ABS_OFFSET;
126  meta.offset = ntohs ( echo->sequence );
127  return xfer_deliver ( &ping->xfer, iob_disown ( iobuf ), &meta );
128 
129  discard:
130  free_iob ( iobuf );
131  return rc;
132 }
#define iob_pull(iobuf, len)
Definition: iobuf.h:98
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
Data transfer metadata.
Definition: xfer.h:22
An ICMP echo request/reply.
Definition: icmp.h:29
#define XFER_FL_ABS_OFFSET
Offset is absolute.
Definition: xfer.h:47
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:145
#define DBGC(...)
Definition: compiler.h:505
A ping connection.
Definition: ping.c:51
#define ntohs(value)
Definition: byteswap.h:136
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition: iobuf.h:208
static struct ping_connection * ping_demux(unsigned int port)
Identify ping connection by local port number.
Definition: ping.c:75
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
int meta(WINDOW *, bool)
#define ENOTCONN
The socket is not connected.
Definition: errno.h:569
Generalized socket address structure.
Definition: socket.h:96
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:151
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:193
void * data
Start of data.
Definition: iobuf.h:44
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69
void * memset(void *dest, int character, size_t len) __nonnull
int echo(void)
Definition: kb.c:133

References assert(), io_buffer::data, DBGC, echo(), ENOTCONN, free_iob(), iob_disown, iob_len(), iob_pull, memset(), meta(), ntohs, ping(), ping_demux(), rc, xfer_deliver(), and XFER_FL_ABS_OFFSET.

◆ ping_alloc_iob()

static struct io_buffer* ping_alloc_iob ( struct ping_connection *ping  __unused,
size_t  len 
)
static

Allocate I/O buffer for ping.

Parameters
pingPing connection
lenPayload size
Return values
iobufI/O buffer, or NULL

Definition at line 142 of file ping.c.

142  {
143  size_t header_len;
144  struct io_buffer *iobuf;
145 
146  header_len = ( MAX_LL_NET_HEADER_LEN + sizeof ( struct icmp_echo ) );
147  iobuf = alloc_iob ( header_len + len );
148  if ( iobuf )
149  iob_reserve ( iobuf, header_len );
150  return iobuf;
151 }
An ICMP echo request/reply.
Definition: icmp.h:29
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:128
#define MAX_LL_NET_HEADER_LEN
Maximum combined length of a link-layer and network-layer header.
Definition: netdevice.h:58
#define iob_reserve(iobuf, len)
Definition: iobuf.h:63
uint32_t len
Length.
Definition: ena.h:14
A persistent I/O buffer.
Definition: iobuf.h:32

References alloc_iob(), iob_reserve, len, and MAX_LL_NET_HEADER_LEN.

◆ ping_deliver()

static int ping_deliver ( struct ping_connection ping,
struct io_buffer iobuf,
struct xfer_metadata meta 
)
static

Deliver datagram as I/O buffer.

Parameters
pingPing connection
iobufI/O buffer
metaData transfer metadata
Return values
rcReturn status code

Definition at line 161 of file ping.c.

162  {
163  struct icmp_echo *echo = iob_push ( iobuf, sizeof ( *echo ) );
164  int rc;
165 
166  /* Construct header */
167  memset ( echo, 0, sizeof ( *echo ) );
168  echo->ident = htons ( ping->port );
169  echo->sequence = htons ( meta->offset );
170 
171  /* Transmit echo request */
172  if ( ( rc = icmp_tx_echo_request ( iob_disown ( iobuf ),
173  &ping->peer ) ) != 0 ) {
174  DBGC ( ping, "PING %p could not transmit: %s\n",
175  ping, strerror ( rc ) );
176  return rc;
177  }
178 
179  return 0;
180 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
int icmp_tx_echo_request(struct io_buffer *iobuf, struct sockaddr_tcpip *st_dest)
Transmit ICMP echo request.
Definition: icmp.c:105
An ICMP echo request/reply.
Definition: icmp.h:29
#define iob_push(iobuf, len)
Definition: iobuf.h:80
#define DBGC(...)
Definition: compiler.h:505
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition: iobuf.h:208
int meta(WINDOW *, bool)
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
#define htons(value)
Definition: byteswap.h:135
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69
void * memset(void *dest, int character, size_t len) __nonnull
int echo(void)
Definition: kb.c:133

References DBGC, echo(), htons, icmp_tx_echo_request(), iob_disown, iob_push, memset(), meta(), ping(), rc, and strerror().

◆ ping_close()

static void ping_close ( struct ping_connection ping,
int  rc 
)
static

Close ping connection.

Parameters
pingPing connection
rcReason for close

Definition at line 188 of file ping.c.

188  {
189 
190  /* Close data transfer interface */
191  intf_shutdown ( &ping->xfer, rc );
192 
193  /* Remove from list of connections and drop list's reference */
194  list_del ( &ping->list );
195  ref_put ( &ping->refcnt );
196 
197  DBGC ( ping, "PING %p closed\n", ping );
198 }
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:273
#define DBGC(...)
Definition: compiler.h:505
#define list_del(list)
Delete an entry from a list.
Definition: list.h:119
#define ref_put(refcnt)
Drop reference to object.
Definition: refcnt.h:106
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69

References DBGC, intf_shutdown(), list_del, ping(), rc, and ref_put.

◆ ping_open()

static int ping_open ( struct interface xfer,
struct sockaddr peer,
struct sockaddr local 
)
static

Open a ping connection.

Parameters
xferData transfer interface
peerPeer socket address
localLocal socket address, or NULL
Return values
rcReturn status code

Definition at line 219 of file ping.c.

220  {
221  struct sockaddr_tcpip *st_peer = ( struct sockaddr_tcpip * ) peer;
222  struct sockaddr_tcpip *st_local = ( struct sockaddr_tcpip * ) local;
223  struct ping_connection *ping;
224  int port;
225  int rc;
226 
227  /* Allocate and initialise structure */
228  ping = zalloc ( sizeof ( *ping ) );
229  if ( ! ping ) {
230  rc = -ENOMEM;
231  goto err_alloc;
232  }
233  DBGC ( ping, "PING %p allocated\n", ping );
234  ref_init ( &ping->refcnt, NULL );
235  intf_init ( &ping->xfer, &ping_xfer_desc, &ping->refcnt );
236  memcpy ( &ping->peer, st_peer, sizeof ( ping->peer ) );
237 
238  /* Bind to local port */
239  port = tcpip_bind ( st_local, ping_port_available );
240  if ( port < 0 ) {
241  rc = port;
242  DBGC ( ping, "PING %p could not bind: %s\n",
243  ping, strerror ( rc ) );
244  goto err_bind;
245  }
246  ping->port = port;
247  DBGC ( ping, "PING %p bound to id %#04x\n", ping, port );
248 
249  /* Attach parent interface, transfer reference to connection
250  * list, and return
251  */
252  intf_plug_plug ( &ping->xfer, xfer );
253  list_add ( &ping->list, &ping_conns );
254  return 0;
255 
256  err_bind:
257  ref_put ( &ping->refcnt );
258  err_alloc:
259  return rc;
260 }
TCP/IP socket address.
Definition: tcpip.h:75
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
static struct interface_descriptor ping_xfer_desc
Ping data transfer interface descriptor.
Definition: ping.c:208
#define list_add(new, head)
Add a new entry to the head of a list.
Definition: list.h:69
#define ref_init(refcnt, free)
Initialise a reference counter.
Definition: refcnt.h:64
#define DBGC(...)
Definition: compiler.h:505
void intf_plug_plug(struct interface *a, struct interface *b)
Plug two object interfaces together.
Definition: interface.c:102
A ping connection.
Definition: ping.c:51
int tcpip_bind(struct sockaddr_tcpip *st_local, int(*available)(int port))
Bind to local TCP/IP port.
Definition: tcpip.c:214
struct interface xfer
Data transfer interface.
Definition: ping.c:63
#define ENOMEM
Not enough space.
Definition: errno.h:534
void * memcpy(void *dest, const void *src, size_t len) __nonnull
u8 port
Port number.
Definition: CIB_PRM.h:31
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
void * zalloc(size_t size)
Allocate cleared memory.
Definition: malloc.c:624
static int ping_port_available(int port)
Check if local port number is available.
Definition: ping.c:91
static void intf_init(struct interface *intf, struct interface_descriptor *desc, struct refcnt *refcnt)
Initialise an object interface.
Definition: interface.h:173
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
#define ref_put(refcnt)
Drop reference to object.
Definition: refcnt.h:106
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69

References DBGC, ENOMEM, intf_init(), intf_plug_plug(), list_add, memcpy(), NULL, ping(), ping_port_available(), ping_xfer_desc, port, rc, ref_init, ref_put, strerror(), tcpip_bind(), ping_connection::xfer, and zalloc().

Variable Documentation

◆ ping_xfer_operations

struct interface_operation ping_xfer_operations[]
static
Initial value:
= {
}
void intf_close(struct interface *intf, int rc)
Close an object interface.
Definition: interface.c:244
A ping connection.
Definition: ping.c:51
struct io_buffer * xfer_alloc_iob(struct interface *intf, size_t len)
Allocate I/O buffer.
Definition: xfer.c:157
static int ping_deliver(struct ping_connection *ping, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram as I/O buffer.
Definition: ping.c:161
#define INTF_OP(op_type, object_type, op_func)
Define an object interface operation.
Definition: interface.h:32
int xfer_deliver(struct interface *intf, struct io_buffer *iobuf, struct xfer_metadata *meta)
Deliver datagram.
Definition: xfer.c:193
static struct io_buffer * ping_alloc_iob(struct ping_connection *ping __unused, size_t len)
Allocate I/O buffer for ping.
Definition: ping.c:142
static void ping_close(struct ping_connection *ping, int rc)
Close ping connection.
Definition: ping.c:188

Ping data transfer interface operations.

Definition at line 201 of file ping.c.

◆ ping_xfer_desc

struct interface_descriptor ping_xfer_desc
static
Initial value:
=
A ping connection.
Definition: ping.c:51
static struct interface_operation ping_xfer_operations[]
Ping data transfer interface operations.
Definition: ping.c:201
struct interface xfer
Data transfer interface.
Definition: ping.c:63
#define INTF_DESC(object_type, intf, operations)
Define an object interface descriptor.
Definition: interface.h:65

Ping data transfer interface descriptor.

Definition at line 208 of file ping.c.

Referenced by ping_open().

◆ __socket_opener

struct socket_opener ping_ipv6_socket_opener __socket_opener
Initial value:
= {
.semantics = PING_SOCK_ECHO,
.family = AF_INET,
.open = ping_open,
}
static int ping_open(struct interface *xfer, struct sockaddr *peer, struct sockaddr *local)
Open a ping connection.
Definition: ping.c:219
#define PING_SOCK_ECHO
Definition: socket.h:33
#define AF_INET
IPv4 Internet addresses.
Definition: socket.h:63

Ping IPv4 socket opener.

Ping IPv6 socket opener.

Definition at line 263 of file ping.c.