aboutsummaryrefslogtreecommitdiff
path: root/libcc1/gdbctx.hh
blob: 99dc9ade8eb42df1a08873700fc3f2293cf6a8a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/* Generic GDB-side plugin
   Copyright (C) 2020-2022 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef CC1_PLUGIN_GDBCTX_HH
#define CC1_PLUGIN_GDBCTX_HH

namespace cc1_plugin
{
  // The compiler context that we hand back to our caller.
  // Due to this, the entire implementation is in this header.
  template<typename T>
  struct base_gdb_plugin : public T
  {
    base_gdb_plugin (const char *plugin_name_, const char *base_name,
		     int version)
      : verbose (false),
	plugin_name (plugin_name_),
	fe_version (version),
	compiler_name (base_name),
	compilerp (new compiler (verbose))
    {
      vtable =
	{
	  GCC_FE_VERSION_1,
	  do_set_arguments_v0,
	  do_set_source_file,
	  do_set_print_callback,
	  do_compile_v0,
	  do_destroy,
	  do_set_verbose,
	  do_compile,
	  do_set_arguments,
	  do_set_triplet_regexp,
	  do_set_driver_filename,
	};

      this->base.ops = &vtable;
    }

    virtual ~base_gdb_plugin () = default;

    // A convenience function to print something.
    void print (const char *str)
    {
      this->print_function (this->print_datum, str);
    }

    // Set the verbose flag.
    void set_verbose (bool v)
    {
      verbose = v;
      if (compilerp != nullptr)
	compilerp->set_verbose (v);
    }

    // Make a new connection.
    void set_connection (int fd, int aux_fd)
    {
      connection.reset (new local_connection (fd, aux_fd, this));
    }

    // This is called just before compilation begins.  It should set
    // any needed callbacks on the connection.
    virtual void add_callbacks () = 0;

    // A local subclass of connection that holds a back-pointer to the
    // context object that we provide to our caller.
    class local_connection : public cc1_plugin::connection
    {
    public:

      local_connection (int fd, int aux_fd, base_gdb_plugin<T> *b)
	: connection (fd, aux_fd),
	  back_ptr (b)
      {
      }

      void print (const char *buf) override
      {
	back_ptr->print (buf);
      }

      base_gdb_plugin<T> *back_ptr;
    };

    std::unique_ptr<local_connection> connection;

    void (*print_function) (void *datum, const char *message) = nullptr;
    void *print_datum = nullptr;

    std::vector<std::string> args;
    std::string source_file;

    /* Non-zero as an equivalent to gcc driver option "-v".  */
    bool verbose;

    const char *plugin_name;
    int fe_version;

    const char *compiler_name;
    std::unique_ptr<cc1_plugin::compiler> compilerp;

  private:

    struct gcc_base_vtable vtable;

    static inline base_gdb_plugin<T> *
    get_self (gcc_base_context *s)
    {
      T *sub = (T *) s;
      return static_cast<base_gdb_plugin<T> *> (sub);
    }

    static void
    do_set_verbose (struct gcc_base_context *s, int /* bool */ verbose)
    {
      base_gdb_plugin<T> *self = get_self (s);

      self->set_verbose (verbose != 0);
    }

    static char *
    do_set_arguments (struct gcc_base_context *s,
		      int argc, char **argv)
    {
      base_gdb_plugin<T> *self = get_self (s);

      std::string compiler;
      char *errmsg = self->compilerp->find (self->compiler_name, compiler);
      if (errmsg != NULL)
	return errmsg;

      self->args.push_back (compiler);

      for (int i = 0; i < argc; ++i)
	self->args.push_back (argv[i]);

      return NULL;
    }

    static char *
    do_set_triplet_regexp (struct gcc_base_context *s,
			   const char *triplet_regexp)
    {
      base_gdb_plugin<T> *self = get_self (s);

      self->compilerp.reset
	(new cc1_plugin::compiler_triplet_regexp (self->verbose,
						  triplet_regexp));
      return NULL;
    }

    static char *
    do_set_driver_filename (struct gcc_base_context *s,
			    const char *driver_filename)
    {
      base_gdb_plugin<T> *self = get_self (s);

      self->compilerp.reset
	(new cc1_plugin::compiler_driver_filename (self->verbose,
						   driver_filename));
      return NULL;
    }

    static char *
    do_set_arguments_v0 (struct gcc_base_context *s,
			 const char *triplet_regexp,
			 int argc, char **argv)
    {
      char *errmsg = do_set_triplet_regexp (s, triplet_regexp);
      if (errmsg != NULL)
	return errmsg;

      return do_set_arguments (s, argc, argv);
    }

    static void
    do_set_source_file (struct gcc_base_context *s,
			const char *file)
    {
      base_gdb_plugin<T> *self = get_self (s);

      self->source_file = file;
    }

    static void
    do_set_print_callback (struct gcc_base_context *s,
			   void (*print_function) (void *datum,
						   const char *message),
			   void *datum)
    {
      base_gdb_plugin<T> *self = get_self (s);

      self->print_function = print_function;
      self->print_datum = datum;
    }

    int fork_exec (char **argv, int spair_fds[2], int stderr_fds[2])
    {
      pid_t child_pid = fork ();

      if (child_pid == -1)
	{
	  close (spair_fds[0]);
	  close (spair_fds[1]);
	  close (stderr_fds[0]);
	  close (stderr_fds[1]);
	  return 0;
	}

      if (child_pid == 0)
	{
	  // Child.
	  dup2 (stderr_fds[1], 1);
	  dup2 (stderr_fds[1], 2);
	  close (stderr_fds[0]);
	  close (stderr_fds[1]);
	  close (spair_fds[0]);

	  execvp (argv[0], argv);
	  _exit (127);
	}
      else
	{
	  // Parent.
	  close (spair_fds[1]);
	  close (stderr_fds[1]);

	  cc1_plugin::status result = cc1_plugin::FAIL;
	  if (connection->send ('H')
	      && ::cc1_plugin::marshall (connection.get (), fe_version))
	    result = connection->wait_for_query ();

	  close (spair_fds[0]);
	  close (stderr_fds[0]);

	  while (true)
	    {
	      int status;

	      if (waitpid (child_pid, &status, 0) == -1)
		{
		  if (errno != EINTR)
		    return 0;
		}

	      if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
		return 0;
	      break;
	    }

	  if (!result)
	    return 0;
	  return 1;
	}
    }

    static int
    do_compile (struct gcc_base_context *s,
		const char *filename)
    {
      base_gdb_plugin<T> *self = get_self (s);

      int fds[2];
      if (socketpair (AF_UNIX, SOCK_STREAM, 0, fds) != 0)
	{
	  self->print ("could not create socketpair\n");
	  return 0;
	}

      int stderr_fds[2];
      if (pipe (stderr_fds) != 0)
	{
	  self->print ("could not create pipe\n");
	  close (fds[0]);
	  close (fds[1]);
	  return 0;
	}

      self->args.push_back (std::string ("-fplugin=") + self->plugin_name);
      self->args.push_back (std::string ("-fplugin-arg-") + self->plugin_name
			    + "-fd=" + std::to_string (fds[1]));

      self->args.push_back (self->source_file);
      self->args.push_back ("-c");
      self->args.push_back ("-o");
      self->args.push_back (filename);
      if (self->verbose)
	self->args.push_back ("-v");

      self->set_connection (fds[0], stderr_fds[0]);

      self->add_callbacks ();

      std::vector<char *> argv (self->args.size () + 1);
      for (unsigned int i = 0; i < self->args.size (); ++i)
	argv[i] = const_cast<char *> (self->args[i].c_str ());

      return self->fork_exec (argv.data (), fds, stderr_fds);
    }

    static int
    do_compile_v0 (struct gcc_base_context *s, const char *filename,
		   int verbose)
    {
      do_set_verbose (s, verbose);
      return do_compile (s, filename);
    }

    static void
    do_destroy (struct gcc_base_context *s)
    {
      base_gdb_plugin<T> *self = get_self (s);

      delete self;
    }
  };

  // Instances of this rpc<> template function are installed into the
  // "vtable"s.  These functions are parameterized by type and method
  // name and forward the call via the connection.
  template<typename CTX, typename R, const char *&NAME, typename... Arg>
  R rpc (CTX *s, Arg... rest)
  {
    base_gdb_plugin<CTX> *self = (base_gdb_plugin<CTX> *) s;
    R result;
    
    if (!cc1_plugin::call (self->connection.get (), NAME, &result, rest...))
      return 0;
    return result;
  }
}

#endif // CC1_PLUGIN_GDBCTX_HH