libutil/stdlog: use size_t not int

Problem: several functions in the internal stdlog class use int types where size_t would be more appropriate. Switch to size_t. Update unit test. Update users.
garlick · Dec 11, 2024 · 174a1d4 · 174a1d4
1 parent af5e55d
commit 174a1d4
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 44 deletions.
diff --git a/src/broker/log.c b/src/broker/log.c
@@ -438,7 +438,8 @@ static void log_fp (FILE *fp, int flags, const char *buf, int len)
 {
     struct stdlog_header hdr;
     const char *msg;
-    int msglen, severity;
+    size_t msglen;
+    int severity;
     uint32_t nodeid;
 
     if (fp) {
@@ -453,7 +454,7 @@ static void log_fp (FILE *fp, int flags, const char *buf, int len)
                      hdr.appname,
                      stdlog_severity_to_string (severity),
                      nodeid,
-                     msglen,
+                     (int)msglen,
                      msg);
         }
     }

diff --git a/src/broker/shutdown.c b/src/broker/shutdown.c
@@ -65,7 +65,7 @@ static int forward_logbuf (flux_t *h,
 {
     struct stdlog_header hdr;
     const char *txt;
-    int txtlen;
+    size_t txtlen;
     char buf[FLUX_MAX_LOGBUF];
     int loglevel;
 
@@ -86,7 +86,7 @@ static int forward_logbuf (flux_t *h,
                      hdr.appname,
                      stdlog_severity_to_string (STDLOG_SEVERITY (hdr.pri)),
                      strtoul (hdr.hostname, NULL, 10),
-                     txtlen,
+                     (int)txtlen,
                      txt) >= sizeof (buf))
         return 0;
     return flux_respond_pack (h, request, "{s:s}", "log", buf);

diff --git a/src/broker/test/overlay.c b/src/broker/test/overlay.c
@@ -683,7 +683,8 @@ void diag_logger (const char *buf, int len, void *arg)
 {
     struct stdlog_header hdr;
     const char *msg;
-    int msglen, severity;
+    size_t msglen;
+    int severity;
     char *s;
 
     if (stdlog_decode (buf, len, &hdr, NULL, NULL, &msg, &msglen) < 0)
@@ -692,7 +693,7 @@ void diag_logger (const char *buf, int len, void *arg)
     if (asprintf (&s,
                   "%s: %.*s\n",
                   stdlog_severity_to_string (severity),
-                  msglen,
+                  (int)msglen,
                   msg) < 0)
         BAIL_OUT ("asprintf failed");
     diag (s);

diff --git a/src/broker/test/runat.c b/src/broker/test/runat.c
@@ -245,7 +245,8 @@ void diag_logger (const char *buf, int len, void *arg)
 {
     struct stdlog_header hdr;
     const char *msg;
-    int msglen, severity;
+    size_t msglen;
+    int severity;
     char *s;
 
     if (stdlog_decode (buf, len, &hdr, NULL, NULL, &msg, &msglen) < 0)
@@ -254,7 +255,7 @@ void diag_logger (const char *buf, int len, void *arg)
     if (asprintf (&s,
                   "%s: %.*s\n",
                   stdlog_severity_to_string (severity),
-                  msglen,
+                  (int)msglen,
                   msg) < 0)
         BAIL_OUT ("asprintf failed");
     diag (s);

diff --git a/src/cmd/builtin/dmesg.c b/src/cmd/builtin/dmesg.c
@@ -209,7 +209,8 @@ void dmesg_print (struct dmesg_ctx *ctx,
 {
     struct stdlog_header hdr;
     const char *msg;
-    int msglen, severity;
+    size_t msglen;
+    int severity;
     uint32_t nodeid;
 
     if (stdlog_decode (buf, len, &hdr, NULL, NULL, &msg, &msglen) < 0)
@@ -225,7 +226,7 @@ void dmesg_print (struct dmesg_ctx *ctx,
                 nodeid,
                 dmesg_color_reset (ctx),
                 severity_color (ctx, severity),
-                msglen,
+                (int)msglen,
                 msg,
                 dmesg_color_reset (ctx));
     }

diff --git a/src/common/libutil/stdlog.c b/src/common/libutil/stdlog.c
@@ -53,13 +53,13 @@ static int next_str (char **p, char **result)
 }
 
 static int next_structured_data (const char *buf,
-                                 int len,
-                                 int *offp,
+                                 size_t len,
+                                 size_t *offp,
                                  const char **sp,
-                                 int *slenp)
+                                 size_t *slenp)
 {
-    int off = *offp;
-    int this = *offp;
+    size_t off = *offp;
+    size_t this = *offp;
     int level = 0;
 
     while (off < len) {
@@ -82,17 +82,17 @@ static int next_structured_data (const char *buf,
 }
 
 int stdlog_decode (const char *buf,
-                   int len,
+                   size_t len,
                    struct stdlog_header *hdr,
                    const char **sdp,
-                   int *sdlenp,
+                   size_t *sdlenp,
                    const char **msgp,
-                   int *msglenp)
+                   size_t *msglenp)
 {
-    int hdr_len = STDLOG_MAX_HEADER;
+    size_t hdr_len = STDLOG_MAX_HEADER;
     char *p = &hdr->buf[0];
     const char *sd;
-    int off, sdlen;
+    size_t off, sdlen;
 
     if (hdr_len > len)
         hdr_len = len;
@@ -133,14 +133,14 @@ int stdlog_decode (const char *buf,
     return 0;
 }
 
-char *stdlog_split_message (const char *buf, int *len, const char *sep)
+char *stdlog_split_message (const char *buf, size_t *len, const char *sep)
 {
     struct stdlog_header hdr;
     const char *msg;
-    int msglen;
-    int off;
+    size_t msglen;
+    size_t off;
     char *xtra;
-    int xtra_len;
+    size_t xtra_len;
 
     if (stdlog_decode (buf, *len, &hdr, NULL, NULL, &msg, &msglen) < 0)
         return NULL;
@@ -166,7 +166,7 @@ char *stdlog_split_message (const char *buf, int *len, const char *sep)
 }
 
 int stdlog_vencodef (char *buf,
-                     int len,
+                     size_t len,
                      struct stdlog_header *hdr,
                      const char *sd,
                      const char *fmt,
@@ -209,7 +209,7 @@ int stdlog_vencodef (char *buf,
 }
 
 int stdlog_encodef (char *buf,
-                    int len,
+                    size_t len,
                     struct stdlog_header *hdr,
                     const char *sd,
                     const char *fmt,
@@ -225,7 +225,7 @@ int stdlog_encodef (char *buf,
 }
 
 int stdlog_encode (char *buf,
-                   int len,
+                   size_t len,
                    struct stdlog_header *hdr,
                    const char *sd,
                    const char *msg)

diff --git a/src/common/libutil/stdlog.h b/src/common/libutil/stdlog.h
@@ -44,28 +44,28 @@ struct stdlog_header {
 };
 
 int stdlog_decode (const char *buf,
-                   int len,
+                   size_t len,
                    struct stdlog_header *hdr,
                    const char **sd,
-                   int *sdlen,
+                   size_t *sdlen,
                    const char **msg,
-                   int *msglen);
+                   size_t *msglen);
 
 int stdlog_encode (char *buf,
-                   int len,
+                   size_t len,
                    struct stdlog_header *hdr,
                    const char *sd,
                    const char *msg);
 
 int stdlog_vencodef (char *buf,
-                     int len,
+                     size_t len,
                      struct stdlog_header *hdr,
                      const char *sd,
                      const char *fmt,
                      va_list ap);
 
 int stdlog_encodef (char *buf,
-                    int len,
+                    size_t len,
                     struct stdlog_header *hdr,
                     const char *sd,
                     const char *fmt,
@@ -77,7 +77,7 @@ int stdlog_encodef (char *buf,
  * Returns NULL if no 'sep' chars or on alloc failure.
  * If non-NULL, caller must free returned value.
  */
-char *stdlog_split_message (const char *buf, int *len, const char *sep);
+char *stdlog_split_message (const char *buf, size_t *len, const char *sep);
 
 void stdlog_init (struct stdlog_header *hdr);
 

diff --git a/src/common/libutil/test/stdlog.c b/src/common/libutil/test/stdlog.c
@@ -48,17 +48,19 @@ void test_split (void)
     char buf[2048];
     char *xtra;
     struct stdlog_header hdr;
-    int len;
-    int msglen;
+    int n;
+    size_t len;
+    size_t msglen;
     const char *msg;
 
     stdlog_init (&hdr);
 
     /* orig=foo\nbar\nbaz */
-    len = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE,
+    n = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE,
                          "foo\nbar\nbaz");
-    ok (len >= 0,
+    ok (n >= 0,
         "stdlog_encode encoded foo\\nbar\\nbaz");
+    len = n;
     xtra = stdlog_split_message (buf, &len, "\r\n");
     ok (xtra != NULL && streq (xtra, "bar\nbaz"),
         "stdlog_split_message got bar\\nbaz");
@@ -67,9 +69,10 @@ void test_split (void)
         "and truncated orig message to foo");
 
     /* xtra=bar\nbaz */
-    len = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE, xtra);
-    ok (len >= 0,
+    n = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE, xtra);
+    ok (n >= 0,
         "stdlog_encode encoded bar\\nbaz");
+    len = n;
     free (xtra);
     xtra = stdlog_split_message (buf, &len, "\r\n");
     ok (xtra != NULL && streq (xtra, "baz"),
@@ -80,9 +83,10 @@ void test_split (void)
         "and truncated orig message to bar");
 
     /* xtra=baz */
-    len = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE, xtra);
-    ok (len >= 0,
+    n = stdlog_encode (buf, sizeof (buf), &hdr, STDLOG_NILVALUE, xtra);
+    ok (n >= 0,
         "stdlog_encode encoded baz");
+    len = n;
     free (xtra);
     xtra = stdlog_split_message (buf, &len, "\r\n");
     ok (xtra == NULL,
@@ -93,9 +97,10 @@ int main(int argc, char** argv)
 {
     char buf[2048];
     struct stdlog_header hdr, cln;
-    int n, len;
+    int n;
+    size_t len;
     const char *sd, *msg;
-    int sdlen, msglen;
+    size_t sdlen, msglen;
 
     plan (NO_PLAN);