tinyformat: force compile-time checks for format string literals

stickies-v · stickies-v · commit b448d6082674 · 2024-10-28T18:59:44.000Z
Callsites such as bitcoin-cli that (incorrectly) fail compile-time
validation can still use tfm::format_raw.
diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp
@@ -540,15 +540,15 @@ class NetinfoRequestHandler : public BaseRequestHandler
         // Report detailed peer connections list sorted by direction and minimum ping time.
         if (DetailsRequested() && !m_peers.empty()) {
             std::sort(m_peers.begin(), m_peers.end());
-            result += strprintf("<->   type   net  v  mping   ping send recv  txn  blk  hb %*s%*s%*s ",
-                                m_max_addr_processed_length, "addrp",
-                                m_max_addr_rate_limited_length, "addrl",
-                                m_max_age_length, "age");
+            result += tfm::format_raw("<->   type   net  v  mping   ping send recv  txn  blk  hb %*s%*s%*s ",
+                                      m_max_addr_processed_length, "addrp",
+                                      m_max_addr_rate_limited_length, "addrl",
+                                      m_max_age_length, "age");
             if (m_is_asmap_on) result += " asmap ";
-            result += strprintf("%*s %-*s%s\n", m_max_id_length, "id", IsAddressSelected() ? m_max_addr_length : 0, IsAddressSelected() ? "address" : "", IsVersionSelected() ? "version" : "");
+            result += tfm::format_raw("%*s %-*s%s\n", m_max_id_length, "id", IsAddressSelected() ? m_max_addr_length : 0, IsAddressSelected() ? "address" : "", IsVersionSelected() ? "version" : "");
             for (const Peer& peer : m_peers) {
                 std::string version{ToString(peer.version) + peer.sub_version};
-                result += strprintf(
+                result += tfm::format_raw(
                     "%3s %6s %5s %2s%7s%7s%5s%5s%5s%5s  %2s %*s%*s%*s%*i %*s %-*s%s\n",
                     peer.is_outbound ? "out" : "in",
                     ConnectionTypeForNetinfo(peer.conn_type),
@@ -575,7 +575,7 @@ class NetinfoRequestHandler : public BaseRequestHandler
                     IsAddressSelected() ? peer.addr : "",
                     IsVersionSelected() && version != "0" ? version : "");
             }
-            result += strprintf("                        ms     ms  sec  sec  min  min                %*s\n\n", m_max_age_length, "min");
+            result += tfm::format_raw("                        ms     ms  sec  sec  min  min                %*s\n\n", m_max_age_length, "min");
         }
 
         // Report peer connection totals by type.
@@ -624,7 +624,7 @@ class NetinfoRequestHandler : public BaseRequestHandler
                 max_addr_size = std::max(addr["address"].get_str().length() + 1, max_addr_size);
             }
             for (const UniValue& addr : local_addrs) {
-                result += strprintf("\n%-*s    port %6i    score %6i", max_addr_size, addr["address"].get_str(), addr["port"].getInt<int>(), addr["score"].getInt<int>());
+                result += tfm::format_raw("\n%-*s    port %6i    score %6i", max_addr_size, addr["address"].get_str(), addr["port"].getInt<int>(), addr["score"].getInt<int>());
             }
         }
 
@@ -1117,10 +1117,10 @@ static void ParseGetInfoResult(UniValue& result)
         }
 
         for (const std::string& wallet : result["balances"].getKeys()) {
-            result_string += strprintf("%*s %s\n",
-                                       max_balance_length,
-                                       result["balances"][wallet].getValStr(),
-                                       wallet.empty() ? "\"\"" : wallet);
+            result_string += tfm::format_raw("%*s %s\n",
+                                             max_balance_length,
+                                             result["balances"][wallet].getValStr(),
+                                             wallet.empty() ? "\"\"" : wallet);
         }
         result_string += "\n";
     }
diff --git a/src/test/fuzz/strprintf.cpp b/src/test/fuzz/strprintf.cpp
@@ -21,7 +21,7 @@
 template <typename... Args>
 void fuzz_fmt(const std::string& fmt, const Args&... args)
 {
-    (void)tfm::format(fmt.c_str(), args...);
+    (void)tfm::format_raw(fmt.c_str(), args...);
 }
 
 FUZZ_TARGET(str_printf)
diff --git a/src/test/fuzz/util/wallet.h b/src/test/fuzz/util/wallet.h
@@ -46,7 +46,7 @@ struct FuzzedWallet {
 
         for (const std::string& desc_fmt : DESCS) {
             for (bool internal : {true, false}) {
-                const auto descriptor{strprintf(desc_fmt.c_str(), "[5aa9973a/66h/4h/2h]" + seed_insecure, int{internal})};
+                const auto descriptor{tfm::format_raw(desc_fmt.c_str(), "[5aa9973a/66h/4h/2h]" + seed_insecure, int{internal})};
 
                 FlatSigningProvider keys;
                 std::string error;
diff --git a/src/tinyformat.h b/src/tinyformat.h
@@ -1056,33 +1056,33 @@ inline void vformat(std::ostream& out, const char* fmt, FormatListRef list)
 #ifdef TINYFORMAT_USE_VARIADIC_TEMPLATES
 
 /// Format list of arguments to the stream according to given format string.
-template<typename... Args>
-void format(std::ostream& out, const char* fmt, const Args&... args)
+template <typename... Args>
+void format_raw(std::ostream& out, const char* fmt, const Args&... args) // Renamed for Bitcoin Core
 {
     vformat(out, fmt, makeFormatList(args...));
 }
 
 /// Format list of arguments according to the given format string and return
 /// the result as a string.
-template<typename... Args>
-std::string format(const char* fmt, const Args&... args)
+template <typename... Args>
+std::string format_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core
 {
     std::ostringstream oss;
-    format(oss, fmt, args...);
+    format_raw(oss, fmt, args...);
     return oss.str();
 }
 
 /// Format list of arguments to std::cout, according to the given format string
-template<typename... Args>
-void printf(const char* fmt, const Args&... args)
+template <typename... Args>
+void printf_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core
 {
-    format(std::cout, fmt, args...);
+    format_raw(std::cout, fmt, args...);
 }
 
-template<typename... Args>
-void printfln(const char* fmt, const Args&... args)
+template <typename... Args>
+void printfln_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core
 {
-    format(std::cout, fmt, args...);
+    format_raw(std::cout, fmt, args...);
     std::cout << '\n';
 }
 
@@ -1150,7 +1150,12 @@ TINYFORMAT_FOREACH_ARGNUM(TINYFORMAT_MAKE_FORMAT_FUNCS)
 template <typename... Args>
 std::string format(util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)
 {
-    return format(fmt.fmt, args...);
+    return format_raw(fmt.fmt, args...);
+}
+template <typename... Args>
+void format(std::ostream& out, util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)
+{
+    return format_raw(out, fmt.fmt, args...);
 }
 } // namespace tinyformat
 
diff --git a/src/util/translation.h b/src/util/translation.h
@@ -59,8 +59,8 @@ bilingual_str format(const bilingual_str& fmt, const Args&... args)
             return arg;
         }
     }};
-    return bilingual_str{tfm::format(fmt.original.c_str(), translate_arg(args, false)...),
-                         tfm::format(fmt.translated.c_str(), translate_arg(args, true)...)};
+    return bilingual_str{tfm::format_raw(fmt.original.c_str(), translate_arg(args, false)...),
+                         tfm::format_raw(fmt.translated.c_str(), translate_arg(args, true)...)};
 }
 } // namespace tinyformat
 

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`template <typename... Args>`
`22`	`22`	`void fuzz_fmt(const std::string& fmt, const Args&... args)`
`23`	`23`	`{`
`24`		`- (void)tfm::format(fmt.c_str(), args...);`
	`24`	`+ (void)tfm::format_raw(fmt.c_str(), args...);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`FUZZ_TARGET(str_printf)`
Original file line number	Diff line number	Diff line change
`@@ -1056,33 +1056,33 @@ inline void vformat(std::ostream& out, const char* fmt, FormatListRef list)`
`1056`	`1056`	`#ifdef TINYFORMAT_USE_VARIADIC_TEMPLATES`
`1057`	`1057`
`1058`	`1058`	`/// Format list of arguments to the stream according to given format string.`
`1059`		`-template<typename... Args>`
`1060`		`-void format(std::ostream& out, const char* fmt, const Args&... args)`
	`1059`	`+template <typename... Args>`
	`1060`	`+void format_raw(std::ostream& out, const char* fmt, const Args&... args) // Renamed for Bitcoin Core`
`1061`	`1061`	`{`
`1062`	`1062`	`vformat(out, fmt, makeFormatList(args...));`
`1063`	`1063`	`}`
`1064`	`1064`
`1065`	`1065`	`/// Format list of arguments according to the given format string and return`
`1066`	`1066`	`/// the result as a string.`
`1067`		`-template<typename... Args>`
`1068`		`-std::string format(const char* fmt, const Args&... args)`
	`1067`	`+template <typename... Args>`
	`1068`	`+std::string format_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core`
`1069`	`1069`	`{`
`1070`	`1070`	`std::ostringstream oss;`
`1071`		`- format(oss, fmt, args...);`
	`1071`	`+ format_raw(oss, fmt, args...);`
`1072`	`1072`	`return oss.str();`
`1073`	`1073`	`}`
`1074`	`1074`
`1075`	`1075`	`/// Format list of arguments to std::cout, according to the given format string`
`1076`		`-template<typename... Args>`
`1077`		`-void printf(const char* fmt, const Args&... args)`
	`1076`	`+template <typename... Args>`
	`1077`	`+void printf_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core`
`1078`	`1078`	`{`
`1079`		`- format(std::cout, fmt, args...);`
	`1079`	`+ format_raw(std::cout, fmt, args...);`
`1080`	`1080`	`}`
`1081`	`1081`
`1082`		`-template<typename... Args>`
`1083`		`-void printfln(const char* fmt, const Args&... args)`
	`1082`	`+template <typename... Args>`
	`1083`	`+void printfln_raw(const char* fmt, const Args&... args) // Renamed for Bitcoin Core`
`1084`	`1084`	`{`
`1085`		`- format(std::cout, fmt, args...);`
	`1085`	`+ format_raw(std::cout, fmt, args...);`
`1086`	`1086`	`std::cout << '\n';`
`1087`	`1087`	`}`
`1088`	`1088`
`@@ -1150,7 +1150,12 @@ TINYFORMAT_FOREACH_ARGNUM(TINYFORMAT_MAKE_FORMAT_FUNCS)`
`1150`	`1150`	`template <typename... Args>`
`1151`	`1151`	`std::string format(util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)`
`1152`	`1152`	`{`
`1153`		`- return format(fmt.fmt, args...);`
	`1153`	`+ return format_raw(fmt.fmt, args...);`
	`1154`	`+}`
	`1155`	`+template <typename... Args>`
	`1156`	`+void format(std::ostream& out, util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)`
	`1157`	`+{`
	`1158`	`+ return format_raw(out, fmt.fmt, args...);`
`1154`	`1159`	`}`
`1155`	`1160`	`} // namespace tinyformat`
`1156`	`1161`
Original file line number	Diff line number	Diff line change
`@@ -59,8 +59,8 @@ bilingual_str format(const bilingual_str& fmt, const Args&... args)`
`59`	`59`	`return arg;`
`60`	`60`	`}`
`61`	`61`	`}};`
`62`		`- return bilingual_str{tfm::format(fmt.original.c_str(), translate_arg(args, false)...),`
`63`		`- tfm::format(fmt.translated.c_str(), translate_arg(args, true)...)};`
	`62`	`+ return bilingual_str{tfm::format_raw(fmt.original.c_str(), translate_arg(args, false)...),`
	`63`	`+ tfm::format_raw(fmt.translated.c_str(), translate_arg(args, true)...)};`
`64`	`64`	`}`
`65`	`65`	`} // namespace tinyformat`
`66`	`66`