CMake: Use CheckAPI's abort/termoutput with dissectors only

I believe this was the original intention, to use these API restricitons with dissectors only (not that I necessarily agree with that policy either), and through copy-paste and lack of clear guidelines it spread to other parts of the build. Rename the checkAPI groups to make it very clear that this is dissector-only. This doesn't mean, of course, that good programming practices shouldn't be followed everywhere. In particular assertions need to be used properly. Don't use them to catch runtime errors or validate input data. This commit will be followed by another removing the various ugly hacks people have been using to get around the checkAPI hammer.
2021-02-26 22:09:15 +00:00 · 2021-02-26 22:09:15 +00:00 · 7f105d3981
parent 142cfb03ac
commit 7f105d3981
32 changed files with 33 additions and 39 deletions
--- a/epan/CMakeLists.txt
+++ b/epan/CMakeLists.txt
@ -415,7 +415,6 @@ CHECKAPI(
 	NAME
 	  epan
 	SWITCHES
-	  --group termoutput:10 --summary-group termoutput
 	SOURCES
 	  ${LIBWIRESHARK_NONGENERATED_FILES}
 )
--- a/epan/crypt/CMakeLists.txt
+++ b/epan/crypt/CMakeLists.txt
@ -71,7 +71,6 @@ CHECKAPI(
 	NAME
 	  crypt
 	SWITCHES
-	  -g termoutput
 	SOURCES
 	  ${CRYPT_FILES}
 )
--- a/epan/dfilter/CMakeLists.txt
+++ b/epan/dfilter/CMakeLists.txt
@ -97,7 +97,6 @@ CHECKAPI(
 	NAME
 	  dfilter
 	SWITCHES
-	  -g termoutput
 	SOURCES
 	  ${DFILTER_NONGENERATED_FILES}
 # LEX files commented out due to use of malloc, free etc.
--- a/epan/dissectors/CMakeLists.txt
+++ b/epan/dissectors/CMakeLists.txt
@ -2084,8 +2084,8 @@ CHECKAPI(
 	NAME
 	  dissectors
 	SWITCHES
-	  --group abort
-	  --group termoutput:5 --summary-group termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted:5 --summary-group dissectors-restricted
 	  --file ${CHECKAPI_FILE_LIST}
 	SOURCES
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/epan/ftypes/CMakeLists.txt
+++ b/epan/ftypes/CMakeLists.txt
@ -66,7 +66,6 @@ CHECKAPI(
 	NAME
 	  ftypes
 	SWITCHES
-	  -g termoutput
 	SOURCES
 	  ${FTYPE_FILES}
 )
--- a/epan/wmem/CMakeLists.txt
+++ b/epan/wmem/CMakeLists.txt
@ -99,7 +99,6 @@ CHECKAPI(
 	NAME
 	  wmem
 	SWITCHES
-	  --group termoutput:1 --summary-group termoutput
 	SOURCES
 	  ${WMEM_FILES}
 )
--- a/epan/wslua/CMakeLists.txt
+++ b/epan/wslua/CMakeLists.txt
@ -158,7 +158,6 @@ CHECKAPI(
 	NAME
 	  wslua
 	SWITCHES
-	  --group termoutput:6 --summary-group termoutput
 	SOURCES
 	  ${WSLUA_FILES}
 )
--- a/plugins/codecs/G711/CMakeLists.txt
+++ b/plugins/codecs/G711/CMakeLists.txt
@ -48,7 +48,6 @@ CHECKAPI(
 	NAME
 	  g711
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/G722/CMakeLists.txt
+++ b/plugins/codecs/G722/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  g722
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/G726/CMakeLists.txt
+++ b/plugins/codecs/G726/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  g726
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/G729/CMakeLists.txt
+++ b/plugins/codecs/G729/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  g729
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/iLBC/CMakeLists.txt
+++ b/plugins/codecs/iLBC/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  ilbc
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/l16_mono/CMakeLists.txt
+++ b/plugins/codecs/l16_mono/CMakeLists.txt
@ -48,7 +48,6 @@ CHECKAPI(
 	NAME
 	  l16mono
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/opus_dec/CMakeLists.txt
+++ b/plugins/codecs/opus_dec/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  opus
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/codecs/sbc/CMakeLists.txt
+++ b/plugins/codecs/sbc/CMakeLists.txt
@ -50,7 +50,6 @@ CHECKAPI(
 	NAME
 	  sbc
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${CODEC_SRC}
 	  ${CODEC_HEADERS}
--- a/plugins/epan/ethercat/CMakeLists.txt
+++ b/plugins/epan/ethercat/CMakeLists.txt
@ -51,7 +51,8 @@ CHECKAPI(
 	NAME
 	  ethercat
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/gryphon/CMakeLists.txt
+++ b/plugins/epan/gryphon/CMakeLists.txt
@ -45,7 +45,8 @@ CHECKAPI(
 	NAME
 	  gryphon
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/irda/CMakeLists.txt
+++ b/plugins/epan/irda/CMakeLists.txt
@ -47,7 +47,8 @@ CHECKAPI(
 	NAME
 	  irda
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/mate/CMakeLists.txt
+++ b/plugins/epan/mate/CMakeLists.txt
@ -61,8 +61,8 @@ CHECKAPI(
 	NAME
 	  mate
 	SWITCHES
-	  --group abort
-	  --group termoutput:1 --summary-group termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/plugins/epan/opcua/CMakeLists.txt
+++ b/plugins/epan/opcua/CMakeLists.txt
@ -61,7 +61,8 @@ CHECKAPI(
 	NAME
 	  opcua
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/plugins/epan/pluginifdemo/CMakeLists.txt
+++ b/plugins/epan/pluginifdemo/CMakeLists.txt
@ -64,7 +64,8 @@ CHECKAPI(
 	NAME
 	  pluginifdemo
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/profinet/CMakeLists.txt
+++ b/plugins/epan/profinet/CMakeLists.txt
@ -60,7 +60,8 @@ CHECKAPI(
 	NAME
 	  profinet
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/plugins/epan/stats_tree/CMakeLists.txt
+++ b/plugins/epan/stats_tree/CMakeLists.txt
@ -43,7 +43,8 @@ CHECKAPI(
 	NAME
 	  stats_tree
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${PLUGIN_FILES}
 	  ${PLUGIN_HEADERS}
--- a/plugins/epan/transum/CMakeLists.txt
+++ b/plugins/epan/transum/CMakeLists.txt
@ -52,8 +52,8 @@ CHECKAPI(
 	NAME
 	  transum
 	SWITCHES
-	  --group abort
-	  --group termoutput:1 --summary-group termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/plugins/epan/unistim/CMakeLists.txt
+++ b/plugins/epan/unistim/CMakeLists.txt
@ -45,7 +45,8 @@ CHECKAPI(
 	NAME
 	  unistim
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/wimax/CMakeLists.txt
+++ b/plugins/epan/wimax/CMakeLists.txt
@ -92,7 +92,8 @@ CHECKAPI(
 	NAME
 	  wimax
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_SUPPORT_SRC}
--- a/plugins/epan/wimaxasncp/CMakeLists.txt
+++ b/plugins/epan/wimaxasncp/CMakeLists.txt
@ -49,7 +49,8 @@ CHECKAPI(
 	NAME
 	  wimaxasncp
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/epan/wimaxmacphy/CMakeLists.txt
+++ b/plugins/epan/wimaxmacphy/CMakeLists.txt
@ -45,7 +45,8 @@ CHECKAPI(
 	NAME
 	  wimaxmacphy
 	SWITCHES
-	  -g abort -g termoutput
+	  --group dissectors-prohibited
+	  --group dissectors-restricted
 	SOURCES
 	  ${DISSECTOR_SRC}
 	  ${DISSECTOR_HEADERS}
--- a/plugins/wiretap/usbdump/CMakeLists.txt
+++ b/plugins/wiretap/usbdump/CMakeLists.txt
@ -48,7 +48,6 @@ CHECKAPI(
 	NAME
 	  usbdump
 	SWITCHES
-	  -g abort -g termoutput
 	SOURCES
 	  ${WIRETAP_SRC}
 	  ${WIRETAP_HEADERS}
--- a/tools/checkAPIs.pl
+++ b/tools/checkAPIs.pl
@ -272,8 +272,8 @@ my %APIs = (
                'qVariantFromValue'
                ] },

-        # APIs that make the program exit. Dissectors shouldn't call these
-        'abort' => { 'count_errors' => 1, 'functions' => [
+        'dissectors-prohibited' => { 'count_errors' => 1, 'functions' => [
+                # APIs that make the program exit. Dissectors shouldn't call these.
                'abort',
                'assert',
                'assert_perror',
@ -282,8 +282,9 @@ my %APIs = (
                'g_error',
                ] },

-        # APIs that print to the terminal. Dissectors shouldn't call these
-        'termoutput' => { 'count_errors' => 0, 'functions' => [
+        'dissectors-restricted' => { 'count_errors' => 0, 'functions' => [
+                # APIs that print to the terminal. Dissectors shouldn't call these.
+                # FIXME: Explain what to use instead.
                'printf',
                'g_warning',
                ] },
--- a/wiretap/CMakeLists.txt
+++ b/wiretap/CMakeLists.txt
@ -202,8 +202,6 @@ CHECKAPI(
 	NAME
 	  wiretap
 	SWITCHES
-	  --group abort:11 --summary-group abort
-	  --group termoutput:1 --summary-group termoutput
 	SOURCES
 	  ${WIRETAP_NONGENERATED_FILES}
 # LEX files commented out due to use of malloc, free etc.
--- a/wsutil/CMakeLists.txt
+++ b/wsutil/CMakeLists.txt
@ -291,7 +291,6 @@ CHECKAPI(
 	NAME
 	  wsutil
 	SWITCHES
-	  --group termoutput:2 --summary-group termoutput
 	SOURCES
 	  ${WSUTIL_COMMON_FILES}
 )