1 | /* Implementation of diagnostic_client_data_hooks for the compilers |
2 | (e.g. with knowledge of "tree", lang_hooks, and timevars). |
3 | Copyright (C) 2022-2024 Free Software Foundation, Inc. |
4 | Contributed by David Malcolm <dmalcolm@redhat.com>. |
5 | |
6 | This file is part of GCC. |
7 | |
8 | GCC is free software; you can redistribute it and/or modify it under |
9 | the terms of the GNU General Public License as published by the Free |
10 | Software Foundation; either version 3, or (at your option) any later |
11 | version. |
12 | |
13 | GCC is distributed in the hope that it will be useful, but WITHOUT ANY |
14 | WARRANTY; without even the implied warranty of MERCHANTABILITY or |
15 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
16 | for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with GCC; see the file COPYING3. If not see |
20 | <http://www.gnu.org/licenses/>. */ |
21 | |
22 | #include "config.h" |
23 | #include "system.h" |
24 | #include "coretypes.h" |
25 | #include "version.h" |
26 | #include "tree.h" |
27 | #include "diagnostic.h" |
28 | #include "tree-logical-location.h" |
29 | #include "diagnostic-client-data-hooks.h" |
30 | #include "diagnostic-format-sarif.h" |
31 | #include "langhooks.h" |
32 | #include "plugin.h" |
33 | #include "timevar.h" |
34 | |
35 | /* Concrete class for supplying a diagnostic_context with information |
36 | about a specific plugin within the client, when the client is the |
37 | compiler (i.e. a GCC plugin). */ |
38 | |
39 | class compiler_diagnostic_client_plugin_info |
40 | : public diagnostic_client_plugin_info |
41 | { |
42 | public: |
43 | compiler_diagnostic_client_plugin_info (const plugin_name_args *args) |
44 | : m_args (args) |
45 | { |
46 | } |
47 | |
48 | const char *get_short_name () const final override |
49 | { |
50 | return m_args->base_name; |
51 | } |
52 | |
53 | const char *get_full_name () const final override |
54 | { |
55 | return m_args->full_name; |
56 | } |
57 | |
58 | const char *get_version () const final override |
59 | { |
60 | return m_args->version; |
61 | } |
62 | |
63 | private: |
64 | const plugin_name_args *m_args; |
65 | }; |
66 | |
67 | /* Concrete subclass of client_version_info for use by compilers proper, |
68 | (i.e. using lang_hooks, and with knowledge of GCC plugins). */ |
69 | |
70 | class compiler_version_info : public client_version_info |
71 | { |
72 | public: |
73 | const char *get_tool_name () const final override |
74 | { |
75 | return lang_hooks.name; |
76 | } |
77 | |
78 | /* Compare with toplev.cc: print_version. |
79 | TARGET_NAME is passed in by the Makefile. */ |
80 | char * |
81 | maybe_make_full_name () const final override |
82 | { |
83 | return xasprintf ("%s %sversion %s (%s)" , |
84 | get_tool_name (), pkgversion_string, version_string, |
85 | TARGET_NAME); |
86 | } |
87 | |
88 | const char *get_version_string () const final override |
89 | { |
90 | return version_string; |
91 | } |
92 | |
93 | char *maybe_make_version_url () const final override |
94 | { |
95 | return xasprintf ("https://gcc.gnu.org/gcc-%i/" , GCC_major_version); |
96 | } |
97 | |
98 | void for_each_plugin (plugin_visitor &visitor) const final override |
99 | { |
100 | ::for_each_plugin (cb: on_plugin_cb, user_data: &visitor); |
101 | } |
102 | |
103 | private: |
104 | static void |
105 | on_plugin_cb (const plugin_name_args *args, |
106 | void *user_data) |
107 | { |
108 | compiler_diagnostic_client_plugin_info cpi (args); |
109 | client_version_info::plugin_visitor *visitor |
110 | = (client_version_info::plugin_visitor *)user_data; |
111 | visitor->on_plugin (cpi); |
112 | } |
113 | }; |
114 | |
115 | /* Subclass of diagnostic_client_data_hooks for use by compilers proper |
116 | i.e. with knowledge of "tree", access to langhooks, timevars etc. */ |
117 | |
118 | class compiler_data_hooks : public diagnostic_client_data_hooks |
119 | { |
120 | public: |
121 | const client_version_info *get_any_version_info () const final override |
122 | { |
123 | return &m_version_info; |
124 | } |
125 | |
126 | const logical_location *get_current_logical_location () const final override |
127 | { |
128 | if (current_function_decl) |
129 | return &m_current_fndecl_logical_loc; |
130 | else |
131 | return NULL; |
132 | } |
133 | |
134 | const char * |
135 | maybe_get_sarif_source_language (const char *filename) const final override |
136 | { |
137 | return lang_hooks.get_sarif_source_language (filename); |
138 | } |
139 | |
140 | void |
141 | add_sarif_invocation_properties (sarif_object &invocation_obj) |
142 | const final override |
143 | { |
144 | if (g_timer) |
145 | if (json::value *timereport_val = g_timer->make_json ()) |
146 | { |
147 | sarif_property_bag &bag_obj |
148 | = invocation_obj.get_or_create_properties (); |
149 | bag_obj.set (key: "gcc/timeReport" , v: timereport_val); |
150 | |
151 | /* If the user requested SARIF output, then assume they want the |
152 | time report data in the SARIF output, and *not* later emitted on |
153 | stderr. |
154 | Implement this by cleaning up the global timer instance now. */ |
155 | delete g_timer; |
156 | g_timer = NULL; |
157 | } |
158 | } |
159 | |
160 | private: |
161 | compiler_version_info m_version_info; |
162 | current_fndecl_logical_location m_current_fndecl_logical_loc; |
163 | }; |
164 | |
165 | /* Create a compiler_data_hooks (so that the class can be local |
166 | to this file). */ |
167 | |
168 | diagnostic_client_data_hooks * |
169 | make_compiler_data_hooks () |
170 | { |
171 | return new compiler_data_hooks (); |
172 | } |
173 | |