From: Alan T. DeKok <aland@freeradius.org>
Date: Thu, 20 Apr 2023 15:18:44 +0000 (-0400)
Subject: use encode_child() consistenly for encoding one thing
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7fa31dfa9990bfe2d0d194400616a892db98488a;p=thirdparty%2Ffreeradius-server.git

use encode_child() consistenly for encoding one thing

while the protocols use random names (attribute, option, etc)
for consistency, our code should use common names.

This also lets us better track code duplication, and lets us do
deduplication.
---

diff --git a/src/protocols/dhcpv4/encode.c b/src/protocols/dhcpv4/encode.c
index 9c7f2fc38c1..964ec0673c0 100644
--- a/src/protocols/dhcpv4/encode.c
+++ b/src/protocols/dhcpv4/encode.c
@@ -38,7 +38,7 @@ static ssize_t encode_value(fr_dbuff_t *dbuff,
 			    fr_da_stack_t *da_stack, unsigned int depth,
 			    fr_dcursor_t *cursor, void *encode_ctx);
 
-static ssize_t encode_option_data(fr_dbuff_t *dbuff,
+static ssize_t encode_child(fr_dbuff_t *dbuff,
 				  fr_da_stack_t *da_stack, unsigned int depth,
 				  fr_dcursor_t *cursor, void *encode_ctx);
 
@@ -294,7 +294,7 @@ static ssize_t encode_tlv(fr_dbuff_t *dbuff,
 	while (fr_dbuff_extend_lowat(&status, &work_dbuff, DHCPV4_OPT_HDR_LEN) > DHCPV4_OPT_HDR_LEN) {
 		FR_PROTO_STACK_PRINT(da_stack, depth);
 
-		len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		if (len < 0) return len;
 
 		/*
@@ -398,7 +398,7 @@ static ssize_t encode_tlv_hdr(fr_dbuff_t *dbuff,
 			      fr_da_stack_t *da_stack, unsigned int depth,
 			      fr_dcursor_t *cursor, void *encode_ctx);
 
-static ssize_t encode_option_data(fr_dbuff_t *dbuff,
+static ssize_t encode_child(fr_dbuff_t *dbuff,
 				  fr_da_stack_t *da_stack, unsigned int depth,
 				  fr_dcursor_t *cursor, void *encode_ctx)
 {
@@ -520,7 +520,7 @@ static ssize_t encode_tlv_hdr(fr_dbuff_t *dbuff,
 	 *	Encode any sub TLVs or values
 	 */
 	while (fr_dbuff_extend_lowat(NULL, &work_dbuff, 3) >= 3) {
-		len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		if (len < 0) return len;
 		if (len == 0) break;		/* Insufficient space */
 
@@ -661,7 +661,7 @@ static ssize_t encode_vsio_hdr(fr_dbuff_t *dbuff,
 	da = da_stack->da[depth + 1];
 
 	while (true) {
-		len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		if (len == 0) break; /* insufficient space */
 		if (len < 0) return len;
 
diff --git a/src/protocols/dhcpv6/encode.c b/src/protocols/dhcpv6/encode.c
index 07beec80667..5d687d61d5e 100644
--- a/src/protocols/dhcpv6/encode.c
+++ b/src/protocols/dhcpv6/encode.c
@@ -374,7 +374,7 @@ static ssize_t encode_vsio_hdr(fr_dbuff_t *dbuff,
 			       fr_da_stack_t *da_stack, unsigned int depth,
 			       fr_dcursor_t *cursor, void *encode_ctx);
 
-static ssize_t encode_option_data(fr_dbuff_t *dbuff,
+static ssize_t encode_child(fr_dbuff_t *dbuff,
 				  fr_da_stack_t *da_stack, unsigned int depth,
 				  fr_dcursor_t *cursor, void *encode_ctx)
 {
@@ -466,7 +466,7 @@ static ssize_t encode_tlv(fr_dbuff_t *dbuff,
 	while (fr_dbuff_extend_lowat(&status, &work_dbuff, DHCPV6_OPT_HDR_LEN) > DHCPV6_OPT_HDR_LEN) {
 		FR_PROTO_STACK_PRINT(da_stack, depth);
 
-		len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		if (len < 0) return len;
 
 		/*
@@ -650,7 +650,7 @@ static ssize_t encode_vsio_hdr(fr_dbuff_t *dbuff,
 	/*
 	 *	Encode the different data types
 	 */
-	len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+	len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 	if (len < 0) return len;
 
 	(void) encode_option_hdr(&hdr, da->attr, fr_dbuff_used(&work_dbuff) - DHCPV6_OPT_HDR_LEN);
@@ -759,7 +759,7 @@ ssize_t fr_dhcpv6_encode_option(fr_dbuff_t *dbuff, fr_dcursor_t *cursor, void *
 		break;
 
 	default:
-		len = encode_option_data(&work_dbuff, &da_stack, depth, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, &da_stack, depth, cursor, encode_ctx);
 		break;
 	}
 	if (len < 0) return len;
diff --git a/src/protocols/dns/encode.c b/src/protocols/dns/encode.c
index 51f0281e46a..1e99be78527 100644
--- a/src/protocols/dns/encode.c
+++ b/src/protocols/dns/encode.c
@@ -228,9 +228,9 @@ static ssize_t encode_value(fr_dbuff_t *dbuff,
 	return fr_dbuff_set(dbuff, &work_dbuff);
 }
 
-static ssize_t encode_option_data(fr_dbuff_t *dbuff,
-				  fr_da_stack_t *da_stack, unsigned int depth,
-				  fr_dcursor_t *cursor, void *encode_ctx)
+static ssize_t encode_child(fr_dbuff_t *dbuff,
+			    fr_da_stack_t *da_stack, unsigned int depth,
+			    fr_dcursor_t *cursor, void *encode_ctx)
 {
 	ssize_t len;
 	fr_pair_t *vp = fr_dcursor_current(cursor);
@@ -311,7 +311,7 @@ static ssize_t encode_tlv(fr_dbuff_t *dbuff,
 	while (fr_dbuff_extend_lowat(&status, &work_dbuff, DNS_OPT_HDR_LEN) > DNS_OPT_HDR_LEN) {
 		FR_PROTO_STACK_PRINT(da_stack, depth);
 
-		len = encode_option_data(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+		len = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		if (len < 0) return len;
 
 		/*
diff --git a/src/protocols/radius/encode.c b/src/protocols/radius/encode.c
index 2ca21ecf767..f6963309f59 100644
--- a/src/protocols/radius/encode.c
+++ b/src/protocols/radius/encode.c
@@ -37,7 +37,7 @@ static ssize_t encode_value(fr_dbuff_t *dbuff,
 			    fr_da_stack_t *da_stack, unsigned int depth,
 			    fr_dcursor_t *cursor, void *encode_ctx);
 
-static ssize_t encode_attribute(fr_dbuff_t *dbuff,
+static ssize_t encode_child(fr_dbuff_t *dbuff,
 				fr_da_stack_t *da_stack, unsigned int depth,
 				fr_dcursor_t *cursor, void *encode_ctx);
 
@@ -296,7 +296,7 @@ static ssize_t encode_tlv(fr_dbuff_t *dbuff,
 			fr_proto_da_stack_build(da_stack, vp ? vp->da : NULL);
 
 		} else {
-			slen = encode_attribute(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
+			slen = encode_child(&work_dbuff, da_stack, depth + 1, cursor, encode_ctx);
 		}
 		if (slen < 0) {
 			if (slen == PAIR_ENCODE_SKIPPED) continue;
@@ -895,7 +895,7 @@ static ssize_t encode_concat(fr_dbuff_t *dbuff,
  * If it's a standard attribute, then vp->da->attr == attribute.
  * Otherwise, attribute may be something else.
  */
-static ssize_t encode_attribute(fr_dbuff_t *dbuff,
+static ssize_t encode_child(fr_dbuff_t *dbuff,
 				 fr_da_stack_t *da_stack, unsigned int depth,
 				 fr_dcursor_t *cursor, void *encode_ctx)
 {
@@ -1340,7 +1340,7 @@ static ssize_t encode_nas_filter_rule(fr_dbuff_t *dbuff,
 
 /** Encode an RFC standard attribute 1..255
  *
- *  This function is not the same as encode_attribute(), because this
+ *  This function is not the same as encode_child(), because this
  *  one treats some "top level" attributes as special.  e.g.
  *  Message-Authenticator.
  */
@@ -1422,7 +1422,7 @@ static ssize_t encode_rfc(fr_dbuff_t *dbuff, fr_da_stack_t *da_stack, unsigned i
 	/*
 	 *	Once we've checked for various top-level magic, RFC attributes are just TLVs.
 	 */
-	return encode_attribute(dbuff, da_stack, depth, cursor, encode_ctx);
+	return encode_child(dbuff, da_stack, depth, cursor, encode_ctx);
 }
 
 /** Encode a data structure into a RADIUS attribute
@@ -1579,7 +1579,7 @@ ssize_t fr_radius_encode_pair(fr_dbuff_t *dbuff, fr_dcursor_t *cursor, void *enc
 
 	case FR_TYPE_TLV:
 		if (!flag_extended(&da->flags)) {
-			slen = encode_attribute(&work_dbuff, &da_stack, 0, cursor, encode_ctx);
+			slen = encode_child(&work_dbuff, &da_stack, 0, cursor, encode_ctx);
 		} else {
 			slen = encode_extended(&work_dbuff, &da_stack, 0, cursor, encode_ctx);
 		}