diff mbox series

[4/9] libnet: Put code for determing TFTP error strings into a separate function

Message ID 1526578856-30967-5-git-send-email-thuth@redhat.com
State Superseded
Headers show
Series Support network booting with pxelinux.cfg files | expand

Commit Message

Thomas Huth May 17, 2018, 5:40 p.m. UTC
This way we can easily re-use the rc --> string translation in later
patches.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 lib/libnet/netload.c |  79 +++------------------------------------
 lib/libnet/tftp.c    | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++
 lib/libnet/tftp.h    |   2 +
 3 files changed, 111 insertions(+), 73 deletions(-)

Comments

Greg Kurz May 18, 2018, 10:47 a.m. UTC | #1
On Thu, 17 May 2018 19:40:51 +0200
Thomas Huth <thuth@redhat.com> wrote:

> This way we can easily re-use the rc --> string translation in later

... which also translates rc into other numerical values. Per curiosity, are
these -103, -104 ... values explained somewhere ?

> patches.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---

Reviewed-by: Greg Kurz <groug@kaod.org>

>  lib/libnet/netload.c |  79 +++------------------------------------
>  lib/libnet/tftp.c    | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  lib/libnet/tftp.h    |   2 +
>  3 files changed, 111 insertions(+), 73 deletions(-)
> 
> diff --git a/lib/libnet/netload.c b/lib/libnet/netload.c
> index add447c..9208e10 100644
> --- a/lib/libnet/netload.c
> +++ b/lib/libnet/netload.c
> @@ -414,79 +414,12 @@ static int tftp_load(filename_ip_t *fnip, void *buffer, int len)
>  	if (rc > 0) {
>  		printf("  TFTP: Received %s (%d KBytes)\n", fnip->filename,
>  		       rc / 1024);
> -	} else if (rc == -1) {
> -		netload_error(0x3003, "unknown TFTP error");
> -		return -103;
> -	} else if (rc == -2) {
> -		netload_error(0x3004, "TFTP buffer of %d bytes "
> -			"is too small for %s",
> -			len, fnip->filename);
> -		return -104;
> -	} else if (rc == -3) {
> -		netload_error(0x3009, "file not found: %s",
> -			fnip->filename);
> -		return -108;
> -	} else if (rc == -4) {
> -		netload_error(0x3010, "TFTP access violation");
> -		return -109;
> -	} else if (rc == -5) {
> -		netload_error(0x3011, "illegal TFTP operation");
> -		return -110;
> -	} else if (rc == -6) {
> -		netload_error(0x3012, "unknown TFTP transfer ID");
> -		return -111;
> -	} else if (rc == -7) {
> -		netload_error(0x3013, "no such TFTP user");
> -		return -112;
> -	} else if (rc == -8) {
> -		netload_error(0x3017, "TFTP blocksize negotiation failed");
> -		return -116;
> -	} else if (rc == -9) {
> -		netload_error(0x3018, "file exceeds maximum TFTP transfer size");
> -		return -117;
> -	} else if (rc <= -10 && rc >= -15) {
> -		const char *icmp_err_str;
> -		switch (rc) {
> -		case -ICMP_NET_UNREACHABLE - 10:
> -			icmp_err_str = "net unreachable";
> -			break;
> -		case -ICMP_HOST_UNREACHABLE - 10:
> -			icmp_err_str = "host unreachable";
> -			break;
> -		case -ICMP_PROTOCOL_UNREACHABLE - 10:
> -			icmp_err_str = "protocol unreachable";
> -			break;
> -		case -ICMP_PORT_UNREACHABLE - 10:
> -			icmp_err_str = "port unreachable";
> -			break;
> -		case -ICMP_FRAGMENTATION_NEEDED - 10:
> -			icmp_err_str = "fragmentation needed and DF set";
> -			break;
> -		case -ICMP_SOURCE_ROUTE_FAILED - 10:
> -			icmp_err_str = "source route failed";
> -			break;
> -		default:
> -			icmp_err_str = " UNKNOWN";
> -			break;
> -		}
> -		netload_error(0x3005, "ICMP ERROR \"%s\"", icmp_err_str);
> -		return -105;
> -	} else if (rc == -40) {
> -		netload_error(0x3014, "TFTP error occurred after "
> -			"%d bad packets received",
> -			tftp_err.bad_tftp_packets);
> -		return -113;
> -	} else if (rc == -41) {
> -		netload_error(0x3015, "TFTP error occurred after "
> -			"missing %d responses",
> -			tftp_err.no_packets);
> -		return -114;
> -	} else if (rc == -42) {
> -		netload_error(0x3016, "TFTP error missing block %d, "
> -			"expected block was %d",
> -			tftp_err.blocks_missed,
> -			tftp_err.blocks_received);
> -		return -115;
> +	} else {
> +		int ecode;
> +		char *errstr = NULL;
> +		rc = tftp_get_error_info(fnip, &tftp_err, rc, &errstr, &ecode);
> +		if (errstr)
> +			netload_error(ecode, errstr);
>  	}
>  
>  	return rc;
> diff --git a/lib/libnet/tftp.c b/lib/libnet/tftp.c
> index d760f03..6d4d209 100644
> --- a/lib/libnet/tftp.c
> +++ b/lib/libnet/tftp.c
> @@ -696,3 +696,106 @@ int parse_tftp_args(char buffer[], char *server_ip, char filename[], int fd,
>  		return 0;
>  	}
>  }
> +
> +int tftp_get_error_info(filename_ip_t *fnip, tftp_err_t *tftperr, int rc,
> +                        char **errstr, int *ecode)
> +{
> +	static char estrbuf[80];
> +	int dummy;
> +
> +	if (!ecode)
> +		ecode = &dummy;
> +
> +	if (rc == -1) {
> +		*ecode = 0x3003;
> +		*errstr = "unknown TFTP error";
> +		return -103;
> +	} else if (rc == -2) {
> +		*ecode = 0x3004;
> +		sprintf(estrbuf, "TFTP buffer of %d bytes is too small for %s",
> +			len, fnip->filename);
> +		*errstr = estrbuf;
> +		return -104;
> +	} else if (rc == -3) {
> +		*ecode = 0x3009;
> +		sprintf(estrbuf, "file not found: %s", fnip->filename);
> +		*errstr = estrbuf;
> +		return -108;
> +	} else if (rc == -4) {
> +		*ecode = 0x3010;
> +		*errstr = "TFTP access violation";
> +		return -109;
> +	} else if (rc == -5) {
> +		*ecode = 0x3011;
> +		*errstr = "illegal TFTP operation";
> +		return -110;
> +	} else if (rc == -6) {
> +		*ecode = 0x3012;
> +		*errstr = "unknown TFTP transfer ID";
> +		return -111;
> +	} else if (rc == -7) {
> +		*ecode = 0x3013;
> +		*errstr = "no such TFTP user";
> +		return -112;
> +	} else if (rc == -8) {
> +		*ecode = 0x3017;
> +		*errstr = "TFTP blocksize negotiation failed";
> +		return -116;
> +	} else if (rc == -9) {
> +		*ecode = 0x3018;
> +		*errstr = "file exceeds maximum TFTP transfer size";
> +		return -117;
> +	} else if (rc <= -10 && rc >= -15) {
> +		const char *icmp_err_str;
> +		switch (rc) {
> +		case -ICMP_NET_UNREACHABLE - 10:
> +			icmp_err_str = "net unreachable";
> +			break;
> +		case -ICMP_HOST_UNREACHABLE - 10:
> +			icmp_err_str = "host unreachable";
> +			break;
> +		case -ICMP_PROTOCOL_UNREACHABLE - 10:
> +			icmp_err_str = "protocol unreachable";
> +			break;
> +		case -ICMP_PORT_UNREACHABLE - 10:
> +			icmp_err_str = "port unreachable";
> +			break;
> +		case -ICMP_FRAGMENTATION_NEEDED - 10:
> +			icmp_err_str = "fragmentation needed and DF set";
> +			break;
> +		case -ICMP_SOURCE_ROUTE_FAILED - 10:
> +			icmp_err_str = "source route failed";
> +			break;
> +		default:
> +			icmp_err_str = "UNKNOWN";
> +			break;
> +		}
> +		*ecode = 0x3005;
> +		sprintf(estrbuf, "ICMP ERROR \"%s\"", icmp_err_str);
> +		*errstr = estrbuf;
> +		return -105;
> +	} else if (rc == -40) {
> +		*ecode = 0x3014;
> +		sprintf(estrbuf,
> +			"TFTP error occurred after %d bad packets received",
> +			tftp_err->bad_tftp_packets);
> +		*errstr = estrbuf;
> +		return -113;
> +	} else if (rc == -41) {
> +		*ecode = 0x3015;
> +		sprintf(estrbuf,
> +			"TFTP error occurred after missing %d responses",
> +			tftp_err->no_packets);
> +		*errstr = estrbuf;
> +		return -114;
> +	} else if (rc == -42) {
> +		*ecode = 0x3016;
> +		sprintf(estrbuf,
> +			"TFTP error missing block %d, expected block was %d",
> +			tftp_err->blocks_missed, tftp_err->blocks_received);
> +		*errstr = estrbuf;
> +		return -115;
> +	}
> +
> +	return rc;
> +}
> diff --git a/lib/libnet/tftp.h b/lib/libnet/tftp.h
> index 6f68d15..3483091 100644
> --- a/lib/libnet/tftp.h
> +++ b/lib/libnet/tftp.h
> @@ -48,5 +48,7 @@ int tftp(filename_ip_t *fnip, unsigned char  *buf, int len, tftp_err_t *err,
>  int32_t handle_tftp(int fd, uint8_t *, int32_t);
>  void handle_tftp_dun(uint8_t err_code);
>  int parse_tftp_args(char buffer[], char *server_ip, char filename[], int fd, int len);
> +int tftp_get_error_info(filename_ip_t *fnip, tftp_err_t *tftperr, int rc,
> +                        char **errstr, int *ecode);
>  
>  #endif
Thomas Huth May 18, 2018, 11:46 a.m. UTC | #2
On 18.05.2018 12:47, Greg Kurz wrote:
> On Thu, 17 May 2018 19:40:51 +0200
> Thomas Huth <thuth@redhat.com> wrote:
> 
>> This way we can easily re-use the rc --> string translation in later
> 
> ... which also translates rc into other numerical values. Per curiosity, are
> these -103, -104 ... values explained somewhere ?

Not that I'm aware of. At least the Forth code simply does this with the
error value in the obp-tftp package:

 net-load dup 0< IF drop 0 THEN

I think the original author of the code just might have tried to return
a unique error number for each error case, so that the error codes from
the TFTP function had to be translated into something else for the final
return value... Anyway, I did not want to touch this logic while
refactoring the code.

 Thomas
Greg Kurz May 18, 2018, 12:03 p.m. UTC | #3
On Fri, 18 May 2018 13:46:37 +0200
Thomas Huth <thuth@redhat.com> wrote:

> On 18.05.2018 12:47, Greg Kurz wrote:
> > On Thu, 17 May 2018 19:40:51 +0200
> > Thomas Huth <thuth@redhat.com> wrote:
> >   
> >> This way we can easily re-use the rc --> string translation in later  
> > 
> > ... which also translates rc into other numerical values. Per curiosity, are
> > these -103, -104 ... values explained somewhere ?  
> 
> Not that I'm aware of. At least the Forth code simply does this with the
> error value in the obp-tftp package:
> 
>  net-load dup 0< IF drop 0 THEN
> 

Well, since netload() already outputs errors to the console, it looks like
it could just return -1.

> I think the original author of the code just might have tried to return
> a unique error number for each error case, so that the error codes from
> the TFTP function had to be translated into something else for the final
> return value... Anyway, I did not want to touch this logic while
> refactoring the code.
> 

Fair enough.

>  Thomas
diff mbox series

Patch

diff --git a/lib/libnet/netload.c b/lib/libnet/netload.c
index add447c..9208e10 100644
--- a/lib/libnet/netload.c
+++ b/lib/libnet/netload.c
@@ -414,79 +414,12 @@  static int tftp_load(filename_ip_t *fnip, void *buffer, int len)
 	if (rc > 0) {
 		printf("  TFTP: Received %s (%d KBytes)\n", fnip->filename,
 		       rc / 1024);
-	} else if (rc == -1) {
-		netload_error(0x3003, "unknown TFTP error");
-		return -103;
-	} else if (rc == -2) {
-		netload_error(0x3004, "TFTP buffer of %d bytes "
-			"is too small for %s",
-			len, fnip->filename);
-		return -104;
-	} else if (rc == -3) {
-		netload_error(0x3009, "file not found: %s",
-			fnip->filename);
-		return -108;
-	} else if (rc == -4) {
-		netload_error(0x3010, "TFTP access violation");
-		return -109;
-	} else if (rc == -5) {
-		netload_error(0x3011, "illegal TFTP operation");
-		return -110;
-	} else if (rc == -6) {
-		netload_error(0x3012, "unknown TFTP transfer ID");
-		return -111;
-	} else if (rc == -7) {
-		netload_error(0x3013, "no such TFTP user");
-		return -112;
-	} else if (rc == -8) {
-		netload_error(0x3017, "TFTP blocksize negotiation failed");
-		return -116;
-	} else if (rc == -9) {
-		netload_error(0x3018, "file exceeds maximum TFTP transfer size");
-		return -117;
-	} else if (rc <= -10 && rc >= -15) {
-		const char *icmp_err_str;
-		switch (rc) {
-		case -ICMP_NET_UNREACHABLE - 10:
-			icmp_err_str = "net unreachable";
-			break;
-		case -ICMP_HOST_UNREACHABLE - 10:
-			icmp_err_str = "host unreachable";
-			break;
-		case -ICMP_PROTOCOL_UNREACHABLE - 10:
-			icmp_err_str = "protocol unreachable";
-			break;
-		case -ICMP_PORT_UNREACHABLE - 10:
-			icmp_err_str = "port unreachable";
-			break;
-		case -ICMP_FRAGMENTATION_NEEDED - 10:
-			icmp_err_str = "fragmentation needed and DF set";
-			break;
-		case -ICMP_SOURCE_ROUTE_FAILED - 10:
-			icmp_err_str = "source route failed";
-			break;
-		default:
-			icmp_err_str = " UNKNOWN";
-			break;
-		}
-		netload_error(0x3005, "ICMP ERROR \"%s\"", icmp_err_str);
-		return -105;
-	} else if (rc == -40) {
-		netload_error(0x3014, "TFTP error occurred after "
-			"%d bad packets received",
-			tftp_err.bad_tftp_packets);
-		return -113;
-	} else if (rc == -41) {
-		netload_error(0x3015, "TFTP error occurred after "
-			"missing %d responses",
-			tftp_err.no_packets);
-		return -114;
-	} else if (rc == -42) {
-		netload_error(0x3016, "TFTP error missing block %d, "
-			"expected block was %d",
-			tftp_err.blocks_missed,
-			tftp_err.blocks_received);
-		return -115;
+	} else {
+		int ecode;
+		char *errstr = NULL;
+		rc = tftp_get_error_info(fnip, &tftp_err, rc, &errstr, &ecode);
+		if (errstr)
+			netload_error(ecode, errstr);
 	}
 
 	return rc;
diff --git a/lib/libnet/tftp.c b/lib/libnet/tftp.c
index d760f03..6d4d209 100644
--- a/lib/libnet/tftp.c
+++ b/lib/libnet/tftp.c
@@ -696,3 +696,106 @@  int parse_tftp_args(char buffer[], char *server_ip, char filename[], int fd,
 		return 0;
 	}
 }
+
+int tftp_get_error_info(filename_ip_t *fnip, tftp_err_t *tftperr, int rc,
+                        char **errstr, int *ecode)
+{
+	static char estrbuf[80];
+	int dummy;
+
+	if (!ecode)
+		ecode = &dummy;
+
+	if (rc == -1) {
+		*ecode = 0x3003;
+		*errstr = "unknown TFTP error";
+		return -103;
+	} else if (rc == -2) {
+		*ecode = 0x3004;
+		sprintf(estrbuf, "TFTP buffer of %d bytes is too small for %s",
+			len, fnip->filename);
+		*errstr = estrbuf;
+		return -104;
+	} else if (rc == -3) {
+		*ecode = 0x3009;
+		sprintf(estrbuf, "file not found: %s", fnip->filename);
+		*errstr = estrbuf;
+		return -108;
+	} else if (rc == -4) {
+		*ecode = 0x3010;
+		*errstr = "TFTP access violation";
+		return -109;
+	} else if (rc == -5) {
+		*ecode = 0x3011;
+		*errstr = "illegal TFTP operation";
+		return -110;
+	} else if (rc == -6) {
+		*ecode = 0x3012;
+		*errstr = "unknown TFTP transfer ID";
+		return -111;
+	} else if (rc == -7) {
+		*ecode = 0x3013;
+		*errstr = "no such TFTP user";
+		return -112;
+	} else if (rc == -8) {
+		*ecode = 0x3017;
+		*errstr = "TFTP blocksize negotiation failed";
+		return -116;
+	} else if (rc == -9) {
+		*ecode = 0x3018;
+		*errstr = "file exceeds maximum TFTP transfer size";
+		return -117;
+	} else if (rc <= -10 && rc >= -15) {
+		const char *icmp_err_str;
+		switch (rc) {
+		case -ICMP_NET_UNREACHABLE - 10:
+			icmp_err_str = "net unreachable";
+			break;
+		case -ICMP_HOST_UNREACHABLE - 10:
+			icmp_err_str = "host unreachable";
+			break;
+		case -ICMP_PROTOCOL_UNREACHABLE - 10:
+			icmp_err_str = "protocol unreachable";
+			break;
+		case -ICMP_PORT_UNREACHABLE - 10:
+			icmp_err_str = "port unreachable";
+			break;
+		case -ICMP_FRAGMENTATION_NEEDED - 10:
+			icmp_err_str = "fragmentation needed and DF set";
+			break;
+		case -ICMP_SOURCE_ROUTE_FAILED - 10:
+			icmp_err_str = "source route failed";
+			break;
+		default:
+			icmp_err_str = "UNKNOWN";
+			break;
+		}
+		*ecode = 0x3005;
+		sprintf(estrbuf, "ICMP ERROR \"%s\"", icmp_err_str);
+		*errstr = estrbuf;
+		return -105;
+	} else if (rc == -40) {
+		*ecode = 0x3014;
+		sprintf(estrbuf,
+			"TFTP error occurred after %d bad packets received",
+			tftp_err->bad_tftp_packets);
+		*errstr = estrbuf;
+		return -113;
+	} else if (rc == -41) {
+		*ecode = 0x3015;
+		sprintf(estrbuf,
+			"TFTP error occurred after missing %d responses",
+			tftp_err->no_packets);
+		*errstr = estrbuf;
+		return -114;
+	} else if (rc == -42) {
+		*ecode = 0x3016;
+		sprintf(estrbuf,
+			"TFTP error missing block %d, expected block was %d",
+			tftp_err->blocks_missed, tftp_err->blocks_received);
+		*errstr = estrbuf;
+		return -115;
+	}
+
+	return rc;
+}
diff --git a/lib/libnet/tftp.h b/lib/libnet/tftp.h
index 6f68d15..3483091 100644
--- a/lib/libnet/tftp.h
+++ b/lib/libnet/tftp.h
@@ -48,5 +48,7 @@  int tftp(filename_ip_t *fnip, unsigned char  *buf, int len, tftp_err_t *err,
 int32_t handle_tftp(int fd, uint8_t *, int32_t);
 void handle_tftp_dun(uint8_t err_code);
 int parse_tftp_args(char buffer[], char *server_ip, char filename[], int fd, int len);
+int tftp_get_error_info(filename_ip_t *fnip, tftp_err_t *tftperr, int rc,
+                        char **errstr, int *ecode);
 
 #endif