iPXE
pingmgmt.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2013 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 <stdint.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <ipxe/pinger.h>
30 #include <ipxe/monojob.h>
31 #include <ipxe/timer.h>
32 #include <usr/pingmgmt.h>
33 
34 /** @file
35  *
36  * ICMP ping management
37  *
38  */
39 
40 /**
41  * Display ping result
42  *
43  * @v src Source socket address, or NULL
44  * @v sequence Sequence number
45  * @v len Payload length
46  * @v rc Status code
47  */
48 static void ping_callback ( struct sockaddr *peer, unsigned int sequence,
49  size_t len, int rc ) {
50 
51  /* Display ping response */
52  printf ( "%zd bytes from %s: seq=%d",
53  len, ( peer ? sock_ntoa ( peer ) : "<none>" ), sequence );
54  if ( rc != 0 )
55  printf ( ": %s", strerror ( rc ) );
56  printf ( "\n" );
57 }
58 
59 /**
60  * Ping a host
61  *
62  * @v hostname Hostname
63  * @v timeout Timeout between pings, in ticks
64  * @v len Payload length
65  * @v count Number of packets to send (or zero for no limit)
66  * @v quiet Inhibit output
67  * @ret rc Return status code
68  */
69 int ping ( const char *hostname, unsigned long timeout, size_t len,
70  unsigned int count, int quiet ) {
71  int rc;
72 
73  /* Create pinger */
74  if ( ( rc = create_pinger ( &monojob, hostname, timeout, len, count,
75  ( quiet ? NULL : ping_callback ) ) ) != 0 ){
76  printf ( "Could not start ping: %s\n", strerror ( rc ) );
77  return rc;
78  }
79 
80  /* Wait for ping to complete */
81  if ( ( rc = monojob_wait ( NULL, 0 ) ) != 0 ) {
82  if ( ! quiet )
83  printf ( "Finished: %s\n", strerror ( rc ) );
84  return rc;
85  }
86 
87  return 0;
88 }
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
int printf(const char *fmt,...)
Write a formatted string to the console.
Definition: vsprintf.c:464
int monojob_wait(const char *string, unsigned long timeout)
Wait for single foreground job to complete.
Definition: monojob.c:81
iPXE timers
int create_pinger(struct interface *job, const char *hostname, unsigned long timeout, size_t len, unsigned int count, void(*callback)(struct sockaddr *src, unsigned int sequence, size_t len, int rc))
Create pinger.
Definition: pinger.c:312
Single foreground job.
ICMP ping management.
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
ICMP ping sender.
struct interface monojob
Definition: monojob.c:56
Generalized socket address structure.
Definition: socket.h:96
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
const char * sock_ntoa(struct sockaddr *sa)
Transcribe socket address.
Definition: socket.c:42
uint32_t len
Length.
Definition: ena.h:14
uint16_t count
Number of entries.
Definition: ena.h:22
void timeout(int)
static void ping_callback(struct sockaddr *peer, unsigned int sequence, size_t len, int rc)
Display ping result.
Definition: pingmgmt.c:48
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
String functions.
int ping(const char *hostname, unsigned long timeout, size_t len, unsigned int count, int quiet)
Ping a host.
Definition: pingmgmt.c:69