Lint includes with IWYU during code scanning

paul-1 · Jan 16, 2023 · 45e8fd8 · 45e8fd8
1 parent 8d2c94d
commit 45e8fd8
Show file tree

Hide file tree

Showing 62 changed files with 342 additions and 220 deletions.
diff --git a/.github/iwyu.imp b/.github/iwyu.imp
@@ -0,0 +1,34 @@
+[
+
+	{ include: [ '<bits/getopt_core.h>', private, '<getopt.h>', public ] },
+	{ include: [ '<bsd/libutil.h>', private, '<bsd/stdlib.h>', public ] },
+	{ include: [ '<bsd/sys/time.h>', private, '<sys/time.h>', public ] },
+	{ symbol: [ 'sig_atomic_t', private, '<signal.h>', public ] },
+
+	{ include: [ '<alsa/conf.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/control.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/error.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/global.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/input.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/mixer.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/output.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/pcm.h>', private, '<alsa/asoundlib.h>', public ] },
+	{ include: [ '<alsa/pcm_ioplug.h>', private, '<alsa/pcm_external.h>', public ] },
+	{ include: [ '<alsa/version.h>', private, '<alsa/asoundlib.h>', public ] },
+
+	{ include: [ '"dbus/dbus-memory.h"', private, '<dbus/dbus.h>', public ] },
+	{ include: [ '"dbus/dbus-protocol.h"', private, '<dbus/dbus.h>', public ] },
+	{ include: [ '"dbus/dbus-shared.h"', private, '<dbus/dbus.h>', public ] },
+
+	{ include: [ '<fdk-aac/FDK_audio.h>', private, '<fdk-aac/aacenc_lib.h>', public ] },
+
+	{ include: [ '<glib/gtypes.h>', private, '<glib.h>', public ] },
+	{ include: [ '"gio/gdbusinterfaceskeleton.h"', private, '<gio/gio.h>', public ] },
+	{ include: [ '"gio/gdbusobjectmanagerserver.h"', private, '<gio/gio.h>', public ] },
+	{ include: [ '"gio/gdbusobjectskeleton.h"', private, '<gio/gio.h>', public ] },
+
+	{ include: [ '<fmt123.h>', private, '<mpg123.h>', public ] },
+
+	{ include: [ '<spandsp/plc.h>', private, '<spandsp.h>', public ] },
+
+]
diff --git a/.github/spellcheck-wordlist.txt b/.github/spellcheck-wordlist.txt
@@ -58,6 +58,7 @@ ATRAC
 BlueALSA
 BlueZ
 Fraunhofer
+IWYU
 LDAC
 MPD
 oFono
@@ -83,6 +84,7 @@ mutex
 natively
 param
 params
+pragma
 proc
 reinitialization
 scalable

diff --git a/.github/workflows/code-scanning.yaml b/.github/workflows/code-scanning.yaml
@@ -80,6 +80,63 @@ jobs:
         ignorePaths: ${{ github.workspace }}/doc/bluealsa-api.txt
         scanPaths: ${{ github.workspace }}
 
+  include-what-you-use:
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Dependencies
+      run: |
+        sudo apt update
+        # XXX: iwyu package depends on clang-14, but is built with clang-13
+        sudo apt install --yes --quiet --no-install-recommends \
+          bear \
+          iwyu libclang-13-dev \
+          libasound2-dev \
+          libbluetooth-dev \
+          libbsd-dev \
+          libdbus-1-dev \
+          libfdk-aac-dev \
+          libglib2.0-dev \
+          libmp3lame-dev \
+          libmpg123-dev \
+          libncurses5-dev \
+          libreadline-dev \
+          libsbc-dev \
+          libspandsp-dev
+    - uses: actions/checkout@v3
+    - name: Create Build Environment
+      run: |
+        mkdir -p ${{ github.workspace }}/{build,m4}
+        autoreconf --install
+    - name: Configure GNU Automake
+      working-directory: ${{ github.workspace }}/build
+      run: |
+        ${{ github.workspace }}/configure \
+          --enable-aac \
+          --enable-debug \
+          --enable-debug-time \
+          --enable-faststream \
+          --enable-mp3lame \
+          --enable-mpg123 \
+          --enable-msbc \
+          --enable-ofono \
+          --enable-upower \
+          --enable-aplay \
+          --enable-cli \
+          --enable-rfcomm \
+          --enable-a2dpconf \
+          --enable-hcitop
+    - name: Build
+      working-directory: ${{ github.workspace }}/build
+      run: bear -- make check TESTS=
+    - name: Run IWYU Check
+      run: |
+        iwyu_tool -p ${{ github.workspace }}/build -- \
+          -Xiwyu --mapping_file=${{ github.workspace }}/.github/iwyu.imp \
+          -Xiwyu --keep=*/config.h \
+          -Xiwyu --no_fwd_decls
+
   markdown-lint:
     strategy:
       fail-fast: false

diff --git a/src/a2dp-aac.c b/src/a2dp-aac.c
@@ -10,10 +10,7 @@
 
 #include "a2dp-aac.h"
 
-#if ENABLE_AAC
-
 #include <errno.h>
-#include <endian.h>
 #include <pthread.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -591,5 +588,3 @@ int a2dp_aac_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-aptx-hd.c b/src/a2dp-aptx-hd.c
@@ -9,10 +9,8 @@
  */
 
 #include "a2dp-aptx-hd.h"
+/* IWYU pragma: no_include "config.h" */
 
-#if ENABLE_APTX_HD
-
-#include <endian.h>
 #include <errno.h>
 #include <pthread.h>
 #include <stdbool.h>
@@ -27,7 +25,6 @@
 #include "codec-aptx.h"
 #include "io.h"
 #include "rtp.h"
-#include "utils.h"
 #include "shared/a2dp-codecs.h"
 #include "shared/defs.h"
 #include "shared/ffb.h"
@@ -347,5 +344,3 @@ int a2dp_aptx_hd_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-aptx.c b/src/a2dp-aptx.c
@@ -9,8 +9,7 @@
  */
 
 #include "a2dp-aptx.h"
-
-#if ENABLE_APTX
+/* IWYU pragma: no_include "config.h" */
 
 #include <errno.h>
 #include <pthread.h>
@@ -25,7 +24,6 @@
 #include "a2dp.h"
 #include "codec-aptx.h"
 #include "io.h"
-#include "utils.h"
 #include "shared/a2dp-codecs.h"
 #include "shared/defs.h"
 #include "shared/ffb.h"
@@ -309,5 +307,3 @@ int a2dp_aptx_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-faststream.c b/src/a2dp-faststream.c
@@ -10,8 +10,6 @@
 
 #include "a2dp-faststream.h"
 
-#if ENABLE_FASTSTREAM
-
 #include <errno.h>
 #include <pthread.h>
 #include <stdbool.h>
@@ -27,7 +25,6 @@
 #include "a2dp.h"
 #include "codec-sbc.h"
 #include "io.h"
-#include "utils.h"
 #include "shared/a2dp-codecs.h"
 #include "shared/defs.h"
 #include "shared/ffb.h"
@@ -335,5 +332,3 @@ int a2dp_faststream_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-lc3plus.c b/src/a2dp-lc3plus.c
@@ -9,15 +9,14 @@
  */
 
 #include "a2dp-lc3plus.h"
+/* IWYU pragma: no_include "config.h" */
 
-#if ENABLE_LC3PLUS
-
-#include <endian.h>
 #include <errno.h>
 #include <pthread.h>
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
+#include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 
@@ -28,7 +27,6 @@
 #include "a2dp.h"
 #include "audio.h"
 #include "bluealsa-config.h"
-#include "codec-sbc.h"
 #include "io.h"
 #include "rtp.h"
 #include "utils.h"
@@ -609,5 +607,3 @@ int a2dp_lc3plus_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-ldac.c b/src/a2dp-ldac.c
@@ -10,10 +10,7 @@
 
 #include "a2dp-ldac.h"
 
-#if ENABLE_LDAC
-
 #include <errno.h>
-#include <endian.h>
 #include <pthread.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -408,5 +405,3 @@ int a2dp_ldac_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-mpeg.c b/src/a2dp-mpeg.c
@@ -9,11 +9,9 @@
  */
 
 #include "a2dp-mpeg.h"
-
-#if ENABLE_MPEG
+/* IWYU pragma: no_include "config.h" */
 
 #include <errno.h>
-#include <endian.h>
 #include <pthread.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -614,5 +612,3 @@ int a2dp_mpeg_transport_start(struct ba_transport *t) {
 	g_assert_not_reached();
 	return -1;
 }
-
-#endif
diff --git a/src/a2dp-sbc.c b/src/a2dp-sbc.c
@@ -9,8 +9,8 @@
  */
 
 #include "a2dp-sbc.h"
+/* IWYU pragma: no_include "config.h" */
 
-#include <endian.h>
 #include <errno.h>
 #include <pthread.h>
 #include <stdbool.h>
@@ -28,7 +28,6 @@
 #include "codec-sbc.h"
 #include "io.h"
 #include "rtp.h"
-#include "utils.h"
 #include "shared/a2dp-codecs.h"
 #include "shared/defs.h"
 #include "shared/ffb.h"

diff --git a/src/a2dp.c b/src/a2dp.c
@@ -9,6 +9,7 @@
  */
 
 #include "a2dp.h"
+/* IWYU pragma: no_include "config.h" */
 
 #include <errno.h>
 #include <limits.h>
@@ -18,19 +19,32 @@
 
 #include <glib.h>
 
-#include "a2dp-aac.h"
-#include "a2dp-aptx-hd.h"
-#include "a2dp-aptx.h"
-#include "a2dp-faststream.h"
-#include "a2dp-lc3plus.h"
-#include "a2dp-ldac.h"
-#include "a2dp-mpeg.h"
+#if ENABLE_AAC
+# include "a2dp-aac.h"
+#endif
+#if ENABLE_APTX
+# include "a2dp-aptx.h"
+#endif
+#if ENABLE_APTX_HD
+# include "a2dp-aptx-hd.h"
+#endif
+#if ENABLE_FASTSTREAM
+# include "a2dp-faststream.h"
+#endif
+#if ENABLE_LC3PLUS
+# include "a2dp-lc3plus.h"
+#endif
+#if ENABLE_LDAC
+# include "a2dp-ldac.h"
+#endif
+#if ENABLE_MPEG
+# include "a2dp-mpeg.h"
+#endif
 #include "a2dp-sbc.h"
 #include "bluealsa-config.h"
 #include "codec-sbc.h"
 #include "hci.h"
 #include "shared/a2dp-codecs.h"
-#include "shared/defs.h"
 #include "shared/log.h"
 
 struct a2dp_codec * const a2dp_codecs[] = {

diff --git a/src/asound/bluealsa-pcm.c b/src/asound/bluealsa-pcm.c
@@ -12,6 +12,7 @@
 # include <config.h>
 #endif
 
+#include <alloca.h>
 #include <errno.h>
 #include <fcntl.h>
 #include <poll.h>
@@ -26,7 +27,7 @@
 #include <strings.h>
 #include <sys/eventfd.h>
 #include <sys/ioctl.h>
-#include <time.h>
+#include <sys/time.h>
 #include <unistd.h>
 
 #include <alsa/asoundlib.h>

diff --git a/src/ba-adapter.c b/src/ba-adapter.c
@@ -9,13 +9,13 @@
  */
 
 #include "ba-adapter.h"
+/* IWYU pragma: no_include "config.h" */
 
 #include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include <bluetooth/bluetooth.h>
 #include <bluetooth/hci.h>
 #include <bluetooth/hci_lib.h>
 

diff --git a/src/ba-adapter.h b/src/ba-adapter.h
@@ -15,11 +15,12 @@
 # include <config.h>
 #endif
 
+#include <stdint.h>
 #include <pthread.h>
 
 #include <glib.h>
 
-#include <bluetooth/bluetooth.h>
+#include <bluetooth/bluetooth.h> /* IWYU pragma: keep */
 #include <bluetooth/hci.h>
 #include <bluetooth/hci_lib.h>