Unify the msg API.

This makes the operations that work on headers start with
nni_msg_header or nng_msg_header.  It also renames _trunc to
_chop (same strlen as _trim), and renames prepend to insert.

We add a shorthand for clearing message content, and make
better use of the endian safe 32-bit accessors too.

This also fixes a bug in inserting large headers into messages.

A test suite for message handling is included.

2 files changed, 17 insertions, 36 deletions

diff --git a/src/protocol/survey/respond.c b/src/protocol/survey/respond.c
index 4db79b86..32513134 100644
--- a/src/protocol/survey/respond.c
+++ b/src/protocol/survey/respond.c
@@ -225,7 +225,6 @@ nni_resp_sock_getq_cb(void *arg)
 {
 	nni_resp_sock *psock = arg;
 	nni_msg *      msg;
-	uint8_t *      header;
 	uint32_t       id;
 	nni_resp_pipe *ppipe;
 	int            rv;
@@ -244,9 +243,7 @@ nni_resp_sock_getq_cb(void *arg)
 		nni_msgq_aio_get(psock->uwq, &psock->aio_getq);
 		return;
 	}
-	header = nni_msg_header(msg);
-	NNI_GET32(header, id);
-	nni_msg_trim_header(msg, 4);
+	id = nni_msg_header_trim_u32(msg);
 
 	nni_mtx_lock(&psock->mtx);
 	rv = nni_idhash_find(psock->pipes, id, (void **) &ppipe);
@@ -301,7 +298,6 @@ nni_resp_recv_cb(void *arg)
 	nni_resp_sock *psock = ppipe->psock;
 	nni_msgq *     urq;
 	nni_msg *      msg;
-	uint8_t        idbuf[4];
 	int            hops;
 	int            rv;
 
@@ -311,13 +307,11 @@ nni_resp_recv_cb(void *arg)
 
 	urq = nni_sock_recvq(psock->nsock);
 
-	NNI_PUT32(idbuf, ppipe->id);
-
 	msg                   = ppipe->aio_recv.a_msg;
 	ppipe->aio_recv.a_msg = NULL;
 
 	// Store the pipe id in the header, first thing.
-	if (nni_msg_append_header(msg, idbuf, 4) != 0) {
+	if (nni_msg_header_append_u32(msg, ppipe->id) != 0) {
 		nni_msg_free(msg);
 		goto error;
 	}
@@ -338,7 +332,7 @@ nni_resp_recv_cb(void *arg)
 		}
 		body = nni_msg_body(msg);
 		end  = (body[0] & 0x80) ? 1 : 0;
-		rv   = nni_msg_append_header(msg, body, 4);
+		rv   = nni_msg_header_append(msg, body, 4);
 		if (rv != 0) {
 			nni_msg_free(msg);
 			goto error;
@@ -439,9 +433,9 @@ nni_resp_sock_sfilter(void *arg, nni_msg *msg)
 	}
 
 	// drop anything else in the header...
-	nni_msg_trunc_header(msg, nni_msg_header_len(msg));
+	nni_msg_header_clear(msg);
 
-	if (nni_msg_append_header(msg, psock->btrace, psock->btrace_len) !=
+	if (nni_msg_header_append(msg, psock->btrace, psock->btrace_len) !=
 	    0) {
 		nni_free(psock->btrace, psock->btrace_len);
 		psock->btrace     = NULL;
@@ -481,7 +475,7 @@ nni_resp_sock_rfilter(void *arg, nni_msg *msg)
 	}
 	psock->btrace_len = len;
 	memcpy(psock->btrace, header, len);
-	nni_msg_trunc_header(msg, len);
+	nni_msg_header_clear(msg);
 	return (msg);
 }
 
diff --git a/src/protocol/survey/survey.c b/src/protocol/survey/survey.c
index 91fe4ad3..45b06d67 100644
--- a/src/protocol/survey/survey.c
+++ b/src/protocol/survey/survey.c
@@ -33,8 +33,8 @@ struct nni_surv_sock {
 	nni_time       expire;
 	int            raw;
 	int            closing;
-	uint32_t       nextid;    // next id
-	uint8_t        survid[4]; // outstanding request ID (big endian)
+	uint32_t       nextid; // next id
+	uint32_t       survid; // outstanding request ID (big endian)
 	nni_list       pipes;
 	nni_aio        aio_getq;
 	nni_timer_node timer;
@@ -271,16 +271,13 @@ nni_surv_recv_cb(void *arg)
 		nni_msg_free(msg);
 		goto failed;
 	}
-	if (nni_msg_append_header(msg, nni_msg_body(msg), 4) != 0) {
+	if (nni_msg_header_append(msg, nni_msg_body(msg), 4) != 0) {
 		// Should be NNG_ENOMEM
 		nni_msg_free(msg);
 		goto failed;
 	}
-	if (nni_msg_trim(msg, 4) != 0) {
-		// This should never happen - could be an assert.
-		nni_msg_free(msg);
-		goto failed;
-	}
+	(void) nni_msg_trim(msg, 4);
+
 	ppipe->aio_putq.a_msg = msg;
 	nni_msgq_aio_put(ppipe->psock->urq, &ppipe->aio_putq);
 	return;
@@ -309,7 +306,7 @@ nni_surv_sock_setopt(void *arg, int opt, const void *buf, size_t sz)
 			} else {
 				nni_sock_recverr(psock->nsock, NNG_ESTATE);
 			}
-			memset(psock->survid, 0, sizeof(psock->survid));
+			psock->survid = 0;
 			nni_timer_cancel(&psock->timer);
 		}
 		break;
@@ -381,7 +378,7 @@ nni_surv_timeout(void *arg)
 	nni_surv_sock *psock = arg;
 
 	nni_sock_lock(psock->nsock);
-	memset(psock->survid, 0, sizeof(psock->survid));
+	psock->survid = 0;
 	nni_sock_recverr(psock->nsock, NNG_ESTATE);
 	nni_msgq_set_get_error(psock->urq, NNG_ETIMEDOUT);
 	nni_sock_unlock(psock->nsock);
@@ -391,7 +388,6 @@ static nni_msg *
 nni_surv_sock_sfilter(void *arg, nni_msg *msg)
 {
 	nni_surv_sock *psock = arg;
-	uint32_t       id;
 
 	if (psock->raw) {
 		// No automatic retry, and the request ID must
@@ -402,12 +398,9 @@ nni_surv_sock_sfilter(void *arg, nni_msg *msg)
 	// Generate a new request ID.  We always set the high
 	// order bit so that the peer can locate the end of the
 	// backtrace.  (Pipe IDs have the high order bit clear.)
-	id = (psock->nextid++) | 0x80000000u;
-
-	// Survey ID is in big endian format.
-	NNI_PUT32(psock->survid, id);
+	psock->survid = (psock->nextid++) | 0x80000000u;
 
-	if (nni_msg_append_header(msg, psock->survid, 4) != 0) {
+	if (nni_msg_header_append_u32(msg, psock->survid) != 0) {
 		// Should be ENOMEM.
 		nni_msg_free(msg);
 		return (NULL);
@@ -436,18 +429,12 @@ nni_surv_sock_rfilter(void *arg, nni_msg *msg)
 		return (msg);
 	}
 
-	if (nni_msg_header_len(msg) < 4) {
-		nni_msg_free(msg);
-		return (NULL);
-	}
-
-	if (memcmp(nni_msg_header(msg), ssock->survid, 4) != 0) {
+	if ((nni_msg_header_len(msg) < sizeof(uint32_t)) ||
+	    (nni_msg_header_trim_u32(msg) != ssock->survid)) {
 		// Wrong request id
 		nni_msg_free(msg);
 		return (NULL);
 	}
-	// Prune the survey ID.
-	nni_msg_trim_header(msg, 4);
 
 	return (msg);
 }