lib9p: Split lib9p_{validate,unmarshal,marshal} into _Tmsg and _Rmsg variants

1 files changed, 26 insertions, 14 deletions

diff --git a/lib9p/include/lib9p/9p.h b/lib9p/include/lib9p/9p.h
index fb1f97d..3d89370 100644
--- a/lib9p/include/lib9p/9p.h
+++ b/lib9p/include/lib9p/9p.h
@@ -1,6 +1,6 @@
 /* lib9p/9p.h - Base 9P protocol definitions for both clients and servers
  *
- * Copyright (C) 2024  Luke T. Shumaker <lukeshu@lukeshu.com>
+ * Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
@@ -49,7 +49,7 @@ int lib9p_errorf(struct lib9p_ctx *ctx, uint32_t linux_errno, char const *fmt, .
 
 const char *lib9p_msg_type_str(struct lib9p_ctx *, enum lib9p_msg_type);
 
-/* main message functions *****************************************************/
+/* main T-message functions ***************************************************/
 
 /**
  * Validate a message's structure; it's size, string encodings, enums,
@@ -68,13 +68,14 @@ const char *lib9p_msg_type_str(struct lib9p_ctx *, enum lib9p_msg_type);
  *
  * @return required size, or -1 on error
  *
+ * @errno LINUX_EOPNOTSUPP: message is an R-message
  * @errno LINUX_EOPNOTSUPP: message has unknown type
  * @errno LINUX_EBADMSG: message is wrong size for content
  * @errno LINUX_EBADMSG: message contains invalid UTF-8
  * @errno LINUX_EBADMSG: message contains a bitfield with unknown bits
  * @errno LINUX_EMSGSIZE: would-be return value overflows SSIZE_MAX
  */
-ssize_t lib9p_validate(struct lib9p_ctx *ctx, uint8_t *net_bytes);
+ssize_t lib9p_Tmsg_validate(struct lib9p_ctx *ctx, uint8_t *net_bytes);
 
 /**
  * Unmarshal the 9P message `net_bytes` into the C struct `ret_body`.
@@ -82,25 +83,25 @@ ssize_t lib9p_validate(struct lib9p_ctx *ctx, uint8_t *net_bytes);
  * Emits an error (return 0, set ctx->err_num and ctx->err_msg) if a
  * string contains invalid UTF-8 or a nul-byte.
  *
- * lib9p_unmarshal does no validation; you must run lib9p_validate()
- * first.
+ * lib9p_unmarshal does no validation; you must run
+ * lib9p_Tmsg_validate() first.
  *
  * @param ctx : negotiated protocol parameters, where to record errors
  * @param net_bytes : the complete message, starting with the "size[4]"
  *
  * @return ret_typ : the mesage type
- * @return ret_body : the message body, must be at least lib9p_validate() bytes
+ * @return ret_body : the message body, must be at least lib9p_Tmsg_validate() bytes
  */
-void lib9p_unmarshal(struct lib9p_ctx *ctx, uint8_t *net_bytes,
-                     enum lib9p_msg_type *ret_typ, void *ret_body);
+void lib9p_Tmsg_unmarshal(struct lib9p_ctx *ctx, uint8_t *net_bytes,
+                          enum lib9p_msg_type *ret_typ, void *ret_body);
 
 /**
  * Marshal a `struct lib9p_msg_{typ}` structure into a byte-array.
  *
- * lib9p_marshal does no validation; it trusts that the programmer
- * won't give it garbage input.  However, just as it doesn't marshal
- * struct fields that aren't in ctx->version, it won't marshal
- * bitfield bits that aren't in ctx->version; it applies a
+ * lib9p_Tmsg_marshal does no validation; it trusts that the
+ * programmer won't give it garbage input.  However, just as it
+ * doesn't marshal struct fields that aren't in ctx->version, it won't
+ * marshal bitfield bits that aren't in ctx->version; it applies a
  * version-specific mask to bitfields.
  *
  * @param ctx : negotiated protocol parameters, where to record errors
@@ -112,8 +113,19 @@ void lib9p_unmarshal(struct lib9p_ctx *ctx, uint8_t *net_bytes,
  *
  * @errno LINUX_ERANGE: reply does not fit in ctx->max_msg_size
  */
-bool lib9p_marshal(struct lib9p_ctx *ctx, enum lib9p_msg_type typ, void *body,
-                   uint8_t *ret_bytes);
+bool lib9p_Tmsg_marshal(struct lib9p_ctx *ctx, enum lib9p_msg_type typ, void *body,
+                        uint8_t *ret_bytes);
+
+/* main R-message functions ***************************************************/
+
+/** Same as above, but for R-messages instead of T-messages.  */
+
+ssize_t lib9p_Rmsg_validate(struct lib9p_ctx *ctx, uint8_t *net_bytes);
+void lib9p_Rmsg_unmarshal(struct lib9p_ctx *ctx, uint8_t *net_bytes,
+                          enum lib9p_msg_type *ret_typ, void *ret_body);
+bool lib9p_Rmsg_marshal(struct lib9p_ctx *ctx, enum lib9p_msg_type typ, void *body,
+                        uint8_t *ret_bytes);
+
 
 /* `struct lib9p_stat` helpers ************************************************/