Skip to contentSkip to conversation

batctl: ping: Add millisecond precision to ping interval

PATCH Superseded Noah Peterson 2 participants 3 messages Oct 18, 2024 – Oct 20, 2024

v1 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

cover batctl: ping: Add millisecond precision to ping interval

There is a minor issue with using the new nanosleep() function: When compiling with the sys/time.h header instead of time.h, a warning is thrown about nanosleep() being implicitly declared when it is called on line 309. This can be fixed by adding the nanosleep() prototype to ping.c, but this triggers the warning "externs should be avoided in .c files" from checkpatch.pl. Is there a third and better option, or should it be left as-is?

Noah Peterson (1):
batctl: ping: Add millisecond precision to ping interval

 ping.c | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)
Signature · 1 line
2.39.5 (Apple Git-154)
#1 lore raw

PATCH 1/1 batctl: ping: Add millisecond precision to ping interval

Modify the batctl ping utility to accept both integer and floating-point values for the interval between sending pings. This enhancement allows specifying intervals with millisecond precision.

For example:
sudo batctl ping aa:bb:cc:dd:ee:ff -i 0.5

Also, improve error handling for invalid interval arguments.

---
 ping.c | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)
ping.c +27 -8
index 3681e7e..104b17c 100644
@@ -16,6 +16,7 @@
 #include <signal.h>
 #include <fcntl.h>
 #include <string.h>
+#include <limits.h>
 #include <math.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -65,14 +66,15 @@ static int ping(struct state *state, int argc, char **argv)
 	struct bat_host *bat_host, *rr_host;
 	ssize_t read_len;
 	int ret = EXIT_FAILURE, res, optchar, found_args = 1;
-	int loop_count = -1, loop_interval = 0, timeout = 1, rr = 0, i;
+	int loop_count = -1, timeout = 1, rr = 0, i;
 	unsigned int seq_counter = 0, packets_out = 0, packets_in = 0, packets_loss;
-	char *dst_string, *mac_string, *rr_string;
-	double time_delta;
+	char *dst_string, *mac_string, *rr_string, *end, *loop_interval = NULL;
+	double time_delta, ping_interval = 0.0;
 	float min = 0.0, max = 0.0, avg = 0.0, mdev = 0.0;
 	uint8_t last_rr_cur = 0, last_rr[BATADV_RR_LEN][ETH_ALEN];
 	size_t packet_len;
 	int disable_translate_mac = 0;
+	struct timespec req;
 
 	while ((optchar = getopt(argc, argv, "hc:i:t:RT")) != -1) {
 		switch (optchar) {
@@ -86,9 +88,7 @@ static int ping(struct state *state, int argc, char **argv)
 			ping_usage();
 			return EXIT_SUCCESS;
 		case 'i':
-			loop_interval = strtol(optarg, NULL , 10);
-			if (loop_interval < 1)
-				loop_interval = 1;
+			loop_interval = strdup(optarg);
 			found_args += ((*((char*)(optarg - 1)) == optchar ) ? 1 : 2);
 			break;
 		case 't':
@@ -135,6 +135,25 @@ static int ping(struct state *state, int argc, char **argv)
 		}
 	}
 
+	if (loop_interval) {
+		errno = 0;
+		ping_interval = strtod(loop_interval, &end);
+		free(loop_interval);
+
+		if (errno || end != (loop_interval + strlen(loop_interval))) {
+			fprintf(stderr, "Error - invalid ping interval '%s'\n", (ULONG_MAX / 1000000 - 1.0));
+			goto out;
+		} else if (ping_interval >= (ULONG_MAX / 1000000 - 1.0)) {
+			fprintf(stderr, "Error - ping interval too large\n");
+			goto out;
+		} else {
+			ping_interval = fmax(ping_interval, 0.001);
+		}
+
+		req.tv_sec = (long) (ping_interval);
+		req.tv_nsec = fmod(ping_interval, 1.0) * 1000000000l;
+	}
+
 	if (!disable_translate_mac)
 		dst_mac = translate_mac(state, dst_mac);
 
@@ -286,8 +305,8 @@ static int ping(struct state *state, int argc, char **argv)
 		if (loop_count == 0)
 			continue;
 
-		if (loop_interval > 0)
-			sleep(loop_interval);
+		if (ping_interval > 0.0)
+			nanosleep(&req, NULL);
 		else if ((tv.tv_sec != 0) || (tv.tv_usec != 0))
 			select(0, NULL, NULL, NULL, &tv);
 	}
Signature · 1 line
2.39.5 (Apple Git-154)
#2 lore raw
Quoted 3 lines · On Friday, 18 October 2024 23:47:13 CEST Noah Peterson wrote:

Modify the batctl ping utility to accept both integer and floating-point values for the interval between sending pings. This enhancement allows specifying intervals with millisecond precision.

You use nanosleep - so this would be nanoseconds. But it is unlikely that we would be able to send in this precise interval. So maybe rename it it subsecond.

Quoted 16 lines

For example:
sudo batctl ping aa:bb:cc:dd:ee:ff -i 0.5

Also, improve error handling for invalid interval arguments.

---
 ping.c | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)
ping.c +0 -0
index 3681e7e..104b17c 100644

ping.c line 22

Quoted 7 lines
ping.c +1 -0
@@ -16,6 +16,7 @@
 #include <signal.h>
 #include <fcntl.h>
 #include <string.h>
+#include <limits.h>
 #include <math.h>
 #include <stddef.h>
 #include <stdint.h>

#include <time.h> missing after <sys/time.h>.

Quoted 20 lines
ping.c +4 -3
@@ -65,14 +66,15 @@ static int ping(struct state *state, int argc, char **argv)
 	struct bat_host *bat_host, *rr_host;
 	ssize_t read_len;
 	int ret = EXIT_FAILURE, res, optchar, found_args = 1;
-	int loop_count = -1, loop_interval = 0, timeout = 1, rr = 0, i;
+	int loop_count = -1, timeout = 1, rr = 0, i;
 	unsigned int seq_counter = 0, packets_out = 0, packets_in = 0, packets_loss;
-	char *dst_string, *mac_string, *rr_string;
-	double time_delta;
+	char *dst_string, *mac_string, *rr_string, *end, *loop_interval = NULL;
+	double time_delta, ping_interval = 0.0;
 	float min = 0.0, max = 0.0, avg = 0.0, mdev = 0.0;
 	uint8_t last_rr_cur = 0, last_rr[BATADV_RR_LEN][ETH_ALEN];
 	size_t packet_len;
 	int disable_translate_mac = 0;
+	struct timespec req;
 
 	while ((optchar = getopt(argc, argv, "hc:i:t:RT")) != -1) {
 		switch (optchar) {

ping.c static int ping(struct state *state, int argc, char **argv) · line 91

Quoted 7 lines
ping.c +1 -3
@@ -86,9 +88,7 @@ static int ping(struct state *state, int argc, char **argv)
 			ping_usage();
 			return EXIT_SUCCESS;
 		case 'i':
-			loop_interval = strtol(optarg, NULL , 10);
-			if (loop_interval < 1)
-				loop_interval = 1;
+			loop_interval = strdup(optarg);

Why are you duplicating this string?

ping.c static int ping(struct state *state, int argc, char **argv) · line 143

Quoted 13 lines
ping.c +6 -0
 			found_args += ((*((char*)(optarg - 1)) == optchar ) ? 1 : 2);
 			break;
 		case 't':
@@ -135,6 +135,25 @@ static int ping(struct state *state, int argc, char **argv)
 		}
 	}
 
+	if (loop_interval) {
+		errno = 0;
+		ping_interval = strtod(loop_interval, &end);
+		free(loop_interval);
+
+		if (errno || end != (loop_interval + strlen(loop_interval))) {

Use after-free of loop_interval

ping.c static int ping(struct state *state, int argc, char **argv) · line 144

Quoted 1 line
ping.c +1 -0
+			fprintf(stderr, "Error - invalid ping interval '%s'\n", (ULONG_MAX / 1000000 - 1.0));

You can't print a double as string. Please use %f, %e or %g to print a double value.

But the text actually suggest that you didn't want to print the calculated value in the first place

ping.c static int ping(struct state *state, int argc, char **argv) · line 146

Quoted 2 lines
ping.c +2 -0
+			goto out;
+		} else if (ping_interval >= (ULONG_MAX / 1000000 - 1.0)) {

Similar to the previously calculated value - this doesn't make a lot of sense. You are dividing ULONG_MAX by 1e6 but we have no place where we handle something related to Msecs or usecs. tv_sec is in time_t and not related to ULONG_MAX / 1e6.

I can also not explain the -1.0 (at the moment). I first thought this was a bad attempt to floor the ping interval - but this would be on the wrong side of the comparison and there is actually a function for that. And since the ULONG_MAX / 1e6 seems to be random, I am unable to find the reason for this.

ping.c static int ping(struct state *state, int argc, char **argv) · line 153

Quoted 7 lines
ping.c +7 -0
+			fprintf(stderr, "Error - ping interval too large\n");
+			goto out;
+		} else {
+			ping_interval = fmax(ping_interval, 0.001);
+		}
+
+		req.tv_sec = (long) (ping_interval);

time_t not long

ping.c static int ping(struct state *state, int argc, char **argv) · line 154

Quoted 1 line
ping.c +1 -0
+               req.tv_nsec = fmod(ping_interval, 1.0) * 1000000000l;

I think this would be a good place to use modf to split integral and fractional part.

Kind regards,
Sven