From a5764b7413b5bf923e32aaac6f905a0988c7e25c Mon Sep 17 00:00:00 2001
From: Thomas Watson <twatson52@icloud.com>
Date: Fri, 23 Feb 2024 15:59:40 -0600
Subject: [PATCH] AP_ROMFS: clarify usage and null termination

Also remove the redundant insertion of the null terminator.
---
 libraries/AP_ROMFS/AP_ROMFS.cpp | 15 ++++++---------
 libraries/AP_ROMFS/AP_ROMFS.h   | 10 +++++-----
 2 files changed, 11 insertions(+), 14 deletions(-)

diff --git a/libraries/AP_ROMFS/AP_ROMFS.cpp b/libraries/AP_ROMFS/AP_ROMFS.cpp
index 3a8542e199..df4e6ad69f 100644
--- a/libraries/AP_ROMFS/AP_ROMFS.cpp
+++ b/libraries/AP_ROMFS/AP_ROMFS.cpp
@@ -45,10 +45,9 @@ const AP_ROMFS::embedded_file *AP_ROMFS::find_file(const char *name)
 }
 
 /*
-  find a compressed file and uncompress it. Space for decompressed data comes
-  from malloc. Caller must be careful to free the resulting data after use. The
-  file data buffer is guaranteed to contain at least one null (though it may be
-  at buf[size]).
+  Find the named file and return its decompressed data and size. Caller must
+  call AP_ROMFS::free() on the return value after use to free it. The data is
+  guaranteed to be null-terminated such that it can be treated as a string.
 */
 const uint8_t *AP_ROMFS::find_decompress(const char *name, uint32_t &size)
 {
@@ -61,20 +60,18 @@ const uint8_t *AP_ROMFS::find_decompress(const char *name, uint32_t &size)
     size = f->decompressed_size;
     return f->contents;
 #else
+    // add one byte for null termination; ArduPilot's malloc will zero it.
     uint8_t *decompressed_data = (uint8_t *)malloc(f->decompressed_size+1);
     if (!decompressed_data) {
         return nullptr;
     }
 
     if (f->decompressed_size == 0) {
-        // empty file
+        // empty file, avoid decompression problems
         size = 0;
         return decompressed_data;
     }
 
-    // explicitly null-terminate the data
-    decompressed_data[f->decompressed_size] = 0;
-
     TINF_DATA *d = (TINF_DATA *)malloc(sizeof(TINF_DATA));
     if (!d) {
         ::free(decompressed_data);
@@ -106,7 +103,7 @@ const uint8_t *AP_ROMFS::find_decompress(const char *name, uint32_t &size)
 #endif
 }
 
-// free returned data
+// free decompressed file data
 void AP_ROMFS::free(const uint8_t *data)
 {
 #ifndef HAL_ROMFS_UNCOMPRESSED
diff --git a/libraries/AP_ROMFS/AP_ROMFS.h b/libraries/AP_ROMFS/AP_ROMFS.h
index 57efa9f5b8..940810dc41 100644
--- a/libraries/AP_ROMFS/AP_ROMFS.h
+++ b/libraries/AP_ROMFS/AP_ROMFS.h
@@ -7,13 +7,13 @@
 
 class AP_ROMFS {
 public:
-    // find a file and de-compress, assumning gzip format. The
-    // decompressed data will be allocated with malloc(). You must
-    // call AP_ROMFS::free() on the return value after use. The next byte after
-    // the file data is guaranteed to be null.
+    //  Find the named file and return its decompressed data and size. Caller
+    //  must call AP_ROMFS::free() on the return value after use to free it.
+    //  The data is guaranteed to be null-terminated such that it can be
+    //  treated as a string.
     static const uint8_t *find_decompress(const char *name, uint32_t &size);
 
-    // free returned data
+    // free decompressed file data
     static void free(const uint8_t *data);
 
     // get the size of a file without decompressing