c-family: Add <time.h> names to diagnostics for known headers

Message ID 20220630151142.1242987-1-jwakely@redhat.com
State Committed
Commit d489ec082ea214109ff54071410f8cd00344e654
Headers
Series c-family: Add <time.h> names to diagnostics for known headers |

Commit Message

Jonathan Wakely June 30, 2022, 3:11 p.m. UTC
  I recently changed <string> to no longer include an unnecessary header,
which meant it no longer includes <pthread.h>, which means it no longer
includes <time.h>. This resulted in some build failures:
https://issues.apache.org/jira/browse/LUCENE-10630
https://github.com/openSUSE/libzypp/pull/405

And that revealed that we don't suggest the right header for those
functions. Fixed like so.

Tested x86_64-linux. OK for trunk?

-- >8 --

gcc/c-family/ChangeLog:

	* known-headers.cc (get_stdlib_header_for_name): Add <time.h>
	names.

gcc/testsuite/ChangeLog:

	* g++.dg/spellcheck-stdlib.C: Check <ctime> types and functions.
---
 gcc/c-family/known-headers.cc            | 14 ++++++++++++
 gcc/testsuite/g++.dg/spellcheck-stdlib.C | 29 ++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
  

Comments

Marek Polacek June 30, 2022, 3:15 p.m. UTC | #1
On Thu, Jun 30, 2022 at 04:11:42PM +0100, Jonathan Wakely via Gcc-patches wrote:
> I recently changed <string> to no longer include an unnecessary header,
> which meant it no longer includes <pthread.h>, which means it no longer
> includes <time.h>. This resulted in some build failures:
> https://issues.apache.org/jira/browse/LUCENE-10630
> https://github.com/openSUSE/libzypp/pull/405
> 
> And that revealed that we don't suggest the right header for those
> functions. Fixed like so.
> 
> Tested x86_64-linux. OK for trunk?

Ok, thanks.
 
> -- >8 --
> 
> gcc/c-family/ChangeLog:
> 
> 	* known-headers.cc (get_stdlib_header_for_name): Add <time.h>
> 	names.
> 
> gcc/testsuite/ChangeLog:
> 
> 	* g++.dg/spellcheck-stdlib.C: Check <ctime> types and functions.
> ---
>  gcc/c-family/known-headers.cc            | 14 ++++++++++++
>  gcc/testsuite/g++.dg/spellcheck-stdlib.C | 29 ++++++++++++++++++++++++
>  2 files changed, 43 insertions(+)
> 
> diff --git a/gcc/c-family/known-headers.cc b/gcc/c-family/known-headers.cc
> index 01c86b27dc8..9c256173b82 100644
> --- a/gcc/c-family/known-headers.cc
> +++ b/gcc/c-family/known-headers.cc
> @@ -199,6 +199,20 @@ get_stdlib_header_for_name (const char *name, enum stdlib lib)
>      {"WINT_MAX", {"<stdint.h>", "<cstdint>"} },
>      {"WINT_MIN", {"<stdint.h>", "<cstdint>"} },
>  
> +    /* <time.h>.  */
> +    {"asctime", {"<time.h>", "<ctime>"} },
> +    {"clock", {"<time.h>", "<ctime>"} },
> +    {"clock_t", {"<time.h>", "<ctime>"} },
> +    {"ctime", {"<time.h>", "<ctime>"} },
> +    {"difftime", {"<time.h>", "<ctime>"} },
> +    {"gmtime", {"<time.h>", "<ctime>"} },
> +    {"localtime", {"<time.h>", "<ctime>"} },
> +    {"mktime", {"<time.h>", "<ctime>"} },
> +    {"strftime", {"<time.h>", "<ctime>"} },
> +    {"time", {"<time.h>", "<ctime>"} },
> +    {"time_t", {"<time.h>", "<ctime>"} },
> +    {"tm", {"<time.h>", "<ctime>"} },
> +
>      /* <wchar.h>.  */
>      {"WCHAR_MAX", {"<wchar.h>", "<cwchar>"} },
>      {"WCHAR_MIN", {"<wchar.h>", "<cwchar>"} }
> diff --git a/gcc/testsuite/g++.dg/spellcheck-stdlib.C b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> index 87736b25e54..7a70641e3ae 100644
> --- a/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> +++ b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> @@ -158,6 +158,35 @@ void test_cstdlib (void *q)
>    // { dg-message "'#include <cstdlib>'" "" { target *-*-* } .-1 }
>  }
>  
> +/* Missing <ctime>.  */
> +
> +void test_ctime (void *q, long s, double d)
> +{
> +  clock_t c; // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  time_t t; // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  tm t2; // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  d = difftime (0, 0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  s = mktime (q); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  s = time (0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  q = asctime (0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  q = ctime (0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  q = gmtime (0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  q = localtime (0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +  char c[2];
> +  strftime (c, 2, "", 0); // { dg-error "was not declared" }
> +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> +}
> +
>  /* Verify that we don't offer suggestions to stdlib globals names when
>     there's an explicit namespace.  */
>  
> -- 
> 2.36.1
> 

Marek
  
Jonathan Wakely July 4, 2022, 4:25 p.m. UTC | #2
On Thu, 30 Jun 2022 at 16:15, Marek Polacek wrote:
>
> On Thu, Jun 30, 2022 at 04:11:42PM +0100, Jonathan Wakely via Gcc-patches wrote:
> > I recently changed <string> to no longer include an unnecessary header,
> > which meant it no longer includes <pthread.h>, which means it no longer
> > includes <time.h>. This resulted in some build failures:
> > https://issues.apache.org/jira/browse/LUCENE-10630
> > https://github.com/openSUSE/libzypp/pull/405
> >
> > And that revealed that we don't suggest the right header for those
> > functions. Fixed like so.
> >
> > Tested x86_64-linux. OK for trunk?
>
> Ok, thanks.

OK for gcc-12 too? I already backported the include streamlining for
<string> that causes several packages to get errors for missing
<ctime>, so it makes sense to also backport these improved
diagnostics.


>
> > -- >8 --
> >
> > gcc/c-family/ChangeLog:
> >
> >       * known-headers.cc (get_stdlib_header_for_name): Add <time.h>
> >       names.
> >
> > gcc/testsuite/ChangeLog:
> >
> >       * g++.dg/spellcheck-stdlib.C: Check <ctime> types and functions.
> > ---
> >  gcc/c-family/known-headers.cc            | 14 ++++++++++++
> >  gcc/testsuite/g++.dg/spellcheck-stdlib.C | 29 ++++++++++++++++++++++++
> >  2 files changed, 43 insertions(+)
> >
> > diff --git a/gcc/c-family/known-headers.cc b/gcc/c-family/known-headers.cc
> > index 01c86b27dc8..9c256173b82 100644
> > --- a/gcc/c-family/known-headers.cc
> > +++ b/gcc/c-family/known-headers.cc
> > @@ -199,6 +199,20 @@ get_stdlib_header_for_name (const char *name, enum stdlib lib)
> >      {"WINT_MAX", {"<stdint.h>", "<cstdint>"} },
> >      {"WINT_MIN", {"<stdint.h>", "<cstdint>"} },
> >
> > +    /* <time.h>.  */
> > +    {"asctime", {"<time.h>", "<ctime>"} },
> > +    {"clock", {"<time.h>", "<ctime>"} },
> > +    {"clock_t", {"<time.h>", "<ctime>"} },
> > +    {"ctime", {"<time.h>", "<ctime>"} },
> > +    {"difftime", {"<time.h>", "<ctime>"} },
> > +    {"gmtime", {"<time.h>", "<ctime>"} },
> > +    {"localtime", {"<time.h>", "<ctime>"} },
> > +    {"mktime", {"<time.h>", "<ctime>"} },
> > +    {"strftime", {"<time.h>", "<ctime>"} },
> > +    {"time", {"<time.h>", "<ctime>"} },
> > +    {"time_t", {"<time.h>", "<ctime>"} },
> > +    {"tm", {"<time.h>", "<ctime>"} },
> > +
> >      /* <wchar.h>.  */
> >      {"WCHAR_MAX", {"<wchar.h>", "<cwchar>"} },
> >      {"WCHAR_MIN", {"<wchar.h>", "<cwchar>"} }
> > diff --git a/gcc/testsuite/g++.dg/spellcheck-stdlib.C b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> > index 87736b25e54..7a70641e3ae 100644
> > --- a/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> > +++ b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
> > @@ -158,6 +158,35 @@ void test_cstdlib (void *q)
> >    // { dg-message "'#include <cstdlib>'" "" { target *-*-* } .-1 }
> >  }
> >
> > +/* Missing <ctime>.  */
> > +
> > +void test_ctime (void *q, long s, double d)
> > +{
> > +  clock_t c; // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  time_t t; // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  tm t2; // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  d = difftime (0, 0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  s = mktime (q); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  s = time (0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  q = asctime (0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  q = ctime (0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  q = gmtime (0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  q = localtime (0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +  char c[2];
> > +  strftime (c, 2, "", 0); // { dg-error "was not declared" }
> > +  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
> > +}
> > +
> >  /* Verify that we don't offer suggestions to stdlib globals names when
> >     there's an explicit namespace.  */
> >
> > --
> > 2.36.1
> >
>
> Marek
>
  
Marek Polacek July 5, 2022, 2:58 p.m. UTC | #3
On Mon, Jul 04, 2022 at 05:25:42PM +0100, Jonathan Wakely wrote:
> On Thu, 30 Jun 2022 at 16:15, Marek Polacek wrote:
> >
> > On Thu, Jun 30, 2022 at 04:11:42PM +0100, Jonathan Wakely via Gcc-patches wrote:
> > > I recently changed <string> to no longer include an unnecessary header,
> > > which meant it no longer includes <pthread.h>, which means it no longer
> > > includes <time.h>. This resulted in some build failures:
> > > https://issues.apache.org/jira/browse/LUCENE-10630
> > > https://github.com/openSUSE/libzypp/pull/405
> > >
> > > And that revealed that we don't suggest the right header for those
> > > functions. Fixed like so.
> > >
> > > Tested x86_64-linux. OK for trunk?
> >
> > Ok, thanks.
> 
> OK for gcc-12 too? I already backported the include streamlining for
> <string> that causes several packages to get errors for missing
> <ctime>, so it makes sense to also backport these improved
> diagnostics.

Since the patch isn't adding any new diagnostics that previously wasn't
there, I think it's OK as well, thanks.

Marek
  

Patch

diff --git a/gcc/c-family/known-headers.cc b/gcc/c-family/known-headers.cc
index 01c86b27dc8..9c256173b82 100644
--- a/gcc/c-family/known-headers.cc
+++ b/gcc/c-family/known-headers.cc
@@ -199,6 +199,20 @@  get_stdlib_header_for_name (const char *name, enum stdlib lib)
     {"WINT_MAX", {"<stdint.h>", "<cstdint>"} },
     {"WINT_MIN", {"<stdint.h>", "<cstdint>"} },
 
+    /* <time.h>.  */
+    {"asctime", {"<time.h>", "<ctime>"} },
+    {"clock", {"<time.h>", "<ctime>"} },
+    {"clock_t", {"<time.h>", "<ctime>"} },
+    {"ctime", {"<time.h>", "<ctime>"} },
+    {"difftime", {"<time.h>", "<ctime>"} },
+    {"gmtime", {"<time.h>", "<ctime>"} },
+    {"localtime", {"<time.h>", "<ctime>"} },
+    {"mktime", {"<time.h>", "<ctime>"} },
+    {"strftime", {"<time.h>", "<ctime>"} },
+    {"time", {"<time.h>", "<ctime>"} },
+    {"time_t", {"<time.h>", "<ctime>"} },
+    {"tm", {"<time.h>", "<ctime>"} },
+
     /* <wchar.h>.  */
     {"WCHAR_MAX", {"<wchar.h>", "<cwchar>"} },
     {"WCHAR_MIN", {"<wchar.h>", "<cwchar>"} }
diff --git a/gcc/testsuite/g++.dg/spellcheck-stdlib.C b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
index 87736b25e54..7a70641e3ae 100644
--- a/gcc/testsuite/g++.dg/spellcheck-stdlib.C
+++ b/gcc/testsuite/g++.dg/spellcheck-stdlib.C
@@ -158,6 +158,35 @@  void test_cstdlib (void *q)
   // { dg-message "'#include <cstdlib>'" "" { target *-*-* } .-1 }
 }
 
+/* Missing <ctime>.  */
+
+void test_ctime (void *q, long s, double d)
+{
+  clock_t c; // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  time_t t; // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  tm t2; // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  d = difftime (0, 0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  s = mktime (q); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  s = time (0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  q = asctime (0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  q = ctime (0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  q = gmtime (0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  q = localtime (0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+  char c[2];
+  strftime (c, 2, "", 0); // { dg-error "was not declared" }
+  // { dg-message "'#include <ctime>'" "" { target *-*-* } .-1 }
+}
+
 /* Verify that we don't offer suggestions to stdlib globals names when
    there's an explicit namespace.  */