From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 1879) id 298D7385841A; Wed, 27 Mar 2024 01:14:34 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 298D7385841A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1711502074; bh=edaX2Fs1PTjAldlIUcz8gpbHLZlTPcGeFiv5wF+hX5E=; h=From:To:Subject:Date:From; b=Z5cOrQ/dXMdmjs8F/DHXeATSCILL+EDSv427vO5uMbmg5niSEm+6Hy0yQa1Buy8/o PlmKftx+fV9CmIKbYq/9wi8OFTrr6MWbuxFqcAzkidA8f8YRC7ZEa0+5MpFJ2P0b2S u5un0HEDLY0g5YQWzlm52fn0baYjRKOTuh8tL5MY= Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Simon Marchi To: gdb-cvs@sourceware.org Subject: [binutils-gdb] gdb, gdbserver, gdbsupport: include early header files with `-include` X-Act-Checkin: binutils-gdb X-Git-Author: Simon Marchi X-Git-Refname: refs/heads/master X-Git-Oldrev: 1d43b17eac183eee00f3168733c055bdf572731d X-Git-Newrev: ab7daea3ad0d9a553ac0e0d37898bdda45ad2c37 Message-Id: <20240327011434.298D7385841A@sourceware.org> Date: Wed, 27 Mar 2024 01:14:34 +0000 (GMT) List-Id: https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3Dab7daea3ad0d= 9a553ac0e0d37898bdda45ad2c37 commit ab7daea3ad0d9a553ac0e0d37898bdda45ad2c37 Author: Simon Marchi Date: Tue Mar 26 15:06:45 2024 -0400 gdb, gdbserver, gdbsupport: include early header files with `-include` =20 The motivation for this change is for analysis tools and IDEs to be better at analyzing header files on their own. =20 There are some definitions and includes we want to occur at the very beginning of all translation units. The way we currently do that is by requiring all source files (.c and .cc files) to include one of defs.h (for gdb), server.h (for gdbserver) of common-defs.h (for gdbsupport and shared source files). These special header files define and include everything that needs to be included at the very beginning. Other header files are written in a way that assume that these special "prologue" header files have already been included. =20 My problem with that is that my editor (clangd-based) provides a very bad experience when editing header files. Since clangd doesn't know that one of defs.h/server.h/common-defs.h was included already, a lot of things are flagged as errors. For instance, CORE_ADDR is not known. It's possible to edit the files in this state, but a lot of the power of the editor is unavailable. =20 My proposal to help with this is to include those things we always want to be there using the compilers' `-include` option. Tom Tromey said that the current approach might exist because not all compilers used to have an option like this. But I believe that it's safe to assume they do today. =20 With this change, clangd picks up the -include option from the compile command, and is able to analyze the header file correctly, as it sees all that stuff included or defined by that -include option. That works because when editing a header file, clangd tries to get the compilation flags from a source file that includes said header file. =20 This change is a bit self-serving, because it addresses one of my frustrations when editing header files, but it might help others too. I'd be curious to know if others encounter the same kinds of problems when editing header files. Also, even if the change is not necessary by any means, I think the solution of using -include for stuff we always want to be there is more elegant than the current solution. =20 Even with this -include flag, many header files currently don't include what they use, but rather depend on files included before them. This will still cause errors when editing them, but it should be easily fixable by adding the appropriate include. There's no rush to do so, as long as the code still compiles, it's just a convenience thing. =20 The changes are: =20 - Add the appropriate `-include` option to the various Makefiles. =20 - There is one particularity for gdbserver's Makefile: we do not want to include server.h when building `gdbreplay.o`, as `gdbreplay.cc` doesn't include it. So we can't simply put the `-include` in `INTERNAL_CFLAGS`. Add the `-include server.h` option to the `COMPILE` and `IPAGENT_COMPILE` variables, and added a special rule to compile `gdbreplay.o` with `-include gdbsupport/common-defs.h`. =20 - Remove the `-include` option from the `check-headers` rule in gdb/Makefile.in, since it is already included in `INTERNAL_CFLAGS`. =20 Change-Id: If3e345d00a9fc42336322f1d8286687d22134340 Approved-By: Pedro Alves Diff: --- gdb/Makefile.in | 3 ++- gdbserver/Makefile.in | 14 ++++++++++++-- gdbsupport/Makefile.am | 1 + gdbsupport/Makefile.in | 1 + 4 files changed, 16 insertions(+), 3 deletions(-) diff --git a/gdb/Makefile.in b/gdb/Makefile.in index a5139ea7580..a9f641c0659 100644 --- a/gdb/Makefile.in +++ b/gdb/Makefile.in @@ -607,6 +607,7 @@ GDB_CFLAGS =3D \ -I. \ -I$(srcdir) \ -I$(srcdir)/config \ + -include $(srcdir)/defs.h \ -DLOCALEDIR=3D"\"$(localedir)\"" \ $(DEFS) =20 @@ -2050,7 +2051,7 @@ check-headers: @echo Checking headers. for i in $(CHECK_HEADERS) ; do \ $(CXX) $(CXX_DIALECT) -x c++-header -c -fsyntax-only \ - $(INTERNAL_CFLAGS) $(CXXFLAGS) -include defs.h $(srcdir)/$$i ; \ + $(INTERNAL_CFLAGS) $(CXXFLAGS) $(srcdir)/$$i ; \ done .PHONY: check-headers =20 diff --git a/gdbserver/Makefile.in b/gdbserver/Makefile.in index 45073abca49..5180e7336cb 100644 --- a/gdbserver/Makefile.in +++ b/gdbserver/Makefile.in @@ -69,9 +69,12 @@ COMPILE.pre =3D $(CXX) $(CXX_DIALECT) COMPILE.post =3D -c -o $@ POSTCOMPILE =3D @true =20 +INCLUDE_SERVER_H =3D -include $(srcdir)/server.h + # CXXFLAGS is at the very end on purpose, so that user-supplied flags can # override internal flags. -COMPILE =3D $(ECHO_CXX) $(COMPILE.pre) $(INTERNAL_CFLAGS) $(CXXFLAGS) $(CO= MPILE.post) +COMPILE =3D $(ECHO_CXX) $(COMPILE.pre) $(INTERNAL_CFLAGS) $(INCLUDE_SERVER= _H) \ + $(CXXFLAGS) $(COMPILE.post) =20 # It is also possible that you will need to add -I/usr/include/sys to the # CFLAGS section if your system doesn't have fcntl.h in /usr/include (which @@ -509,7 +512,8 @@ IPAGENT_CFLAGS =3D \ =20 # CXXFLAGS is at the very end on purpose, so that user-supplied flags can # override internal flags. -IPAGENT_COMPILE =3D $(ECHO_CXX) $(COMPILE.pre) $(IPAGENT_CFLAGS) $(CXXFLAG= S) $(COMPILE.post) +IPAGENT_COMPILE =3D $(ECHO_CXX) $(COMPILE.pre) $(IPAGENT_CFLAGS) \ + $(INCLUDE_SERVER_H) $(CXXFLAGS) $(COMPILE.post) =20 # Rules for special cases. =20 @@ -589,6 +593,12 @@ target/%.o: ../gdb/target/%.c %-generated.cc: ../gdb/regformats/rs6000/%.dat $(regdat_sh) $(ECHO_REGDAT) $(SHELL) $(regdat_sh) $< $@ =20 +# Rule for gdbreplay.o. This is the same as COMPILE, but includes common-= defs.h +# instead of server.h. +gdbreplay.o: gdbreplay.cc + $(ECHO_CXX) $(COMPILE.pre) $(INTERNAL_CFLAGS) $(CXXFLAGS) \ + -include gdbsupport/common-defs.h $(COMPILE.post) $< + # # Dependency tracking. # diff --git a/gdbsupport/Makefile.am b/gdbsupport/Makefile.am index 7c360aa413e..2b0f987125c 100644 --- a/gdbsupport/Makefile.am +++ b/gdbsupport/Makefile.am @@ -35,6 +35,7 @@ AM_CPPFLAGS =3D \ $(INCINTL) \ -I../bfd \ -I$(srcdir)/../bfd \ + -include $(srcdir)/common-defs.h \ @LARGEFILE_CPPFLAGS@ =20 override CXX +=3D $(CXX_DIALECT) diff --git a/gdbsupport/Makefile.in b/gdbsupport/Makefile.in index ab35b9148a5..ee709112aae 100644 --- a/gdbsupport/Makefile.in +++ b/gdbsupport/Makefile.in @@ -403,6 +403,7 @@ AM_CPPFLAGS =3D \ $(INCINTL) \ -I../bfd \ -I$(srcdir)/../bfd \ + -include $(srcdir)/common-defs.h \ @LARGEFILE_CPPFLAGS@ =20 AM_CXXFLAGS =3D $(WARN_CFLAGS) $(WERROR_CFLAGS)