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