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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
|
#ifndef __MONO_DEBUGGER_SERVER_H__
#define __MONO_DEBUGGER_SERVER_H__
#include <breakpoints.h>
#include <signal.h>
#include <glib.h>
G_BEGIN_DECLS
#define MONO_DEBUGGER_REMOTE_VERSION 1
#define MONO_DEBUGGER_REMOTE_MAGIC 0x36885fe4
/*
* Keep in sync with TargetExceptionType in classes/TargetException.cs.
*/
typedef enum {
COMMAND_ERROR_NONE = 0,
COMMAND_ERROR_UNKNOWN_ERROR,
COMMAND_ERROR_INTERNAL_ERROR,
COMMAND_ERROR_NO_TARGET,
COMMAND_ERROR_ALREADY_HAVE_TARGET,
COMMAND_ERROR_CANNOT_START_TARGET,
COMMAND_ERROR_NOT_STOPPED,
COMMAND_ERROR_ALREADY_STOPPED,
COMMAND_ERROR_RECURSIVE_CALL,
COMMAND_ERROR_NO_SUCH_BREAKPOINT,
COMMAND_ERROR_NO_SUCH_REGISTER,
COMMAND_ERROR_DR_OCCUPIED,
COMMAND_ERROR_MEMORY_ACCESS,
COMMAND_ERROR_NOT_IMPLEMENTED,
COMMAND_ERROR_IO_ERROR,
COMMAND_ERROR_NO_CALLBACK_FRAME,
} ServerCommandError;
typedef enum {
MESSAGE_NONE,
MESSAGE_UNKNOWN_ERROR = 1,
MESSAGE_CHILD_EXITED = 2,
MESSAGE_CHILD_STOPPED,
MESSAGE_CHILD_SIGNALED,
MESSAGE_CHILD_CALLBACK,
MESSAGE_CHILD_CALLBACK_COMPLETED,
MESSAGE_CHILD_HIT_BREAKPOINT,
MESSAGE_CHILD_MEMORY_CHANGED,
MESSAGE_CHILD_CREATED_THREAD,
MESSAGE_CHILD_FORKED,
MESSAGE_CHILD_EXECD,
MESSAGE_CHILD_CALLED_EXIT,
MESSAGE_CHILD_NOTIFICATION,
MESSAGE_CHILD_INTERRUPTED
} ServerStatusMessageType;
typedef struct {
ServerStatusMessageType type;
guint32 arg;
} ServerStatusMessage;
typedef struct {
guint64 address;
guint64 stack_pointer;
guint64 frame_address;
} StackFrame;
#define EXECUTABLE_CODE_CHUNK_SIZE 16
typedef struct
{
guint32 address_size;
guint64 notification_address;
guint64 executable_code_buffer;
guint32 executable_code_buffer_size;
guint32 executable_code_chunk_size;
guint32 executable_code_total_chunks;
guint64 breakpoint_info_area;
guint64 breakpoint_table;
guint32 breakpoint_table_size;
/* Private */
guint8 *breakpoint_table_bitfield;
guint8 *executable_code_bitfield;
} MonoRuntimeInfo;
/* This is an opaque data structure which the backend may use to store stuff. */
typedef struct InferiorVTable InferiorVTable;
typedef struct InferiorHandle InferiorHandle;
typedef struct ServerHandle ServerHandle;
typedef struct ArchInfo ArchInfo;
/* C# delegates. */
typedef void (*ChildOutputFunc) (const char *output);
typedef struct {
int sigkill;
int sigstop;
int sigint;
int sigchld;
int mono_thread_abort;
} SignalInfo;
/*
* Server functions.
*
* When porting the debugger to another architecture, you need to implement all functions
* in this vtable.
*
* It is a requirement that all functions always return immediately without blocking.
* If the requested operation cannot be performed (for instance because the target is currently
* running, don't wait for it but return an error condition!).
*/
struct ServerHandle {
ArchInfo *arch;
InferiorHandle *inferior;
MonoRuntimeInfo *mono_runtime;
BreakpointManager *bpm;
};
struct InferiorVTable {
void (* global_init) (void);
ServerHandle * (* create_inferior) (BreakpointManager *bpm);
ServerCommandError (* initialize_process) (ServerHandle *handle);
ServerCommandError (* initialize_thread) (ServerHandle *handle,
guint32 pid);
void (* set_runtime_info) (ServerHandle *handle,
MonoRuntimeInfo *mono_runtime_info);
ServerCommandError (* spawn) (ServerHandle *handle,
const gchar *working_directory,
const gchar **argv,
const gchar **envp,
gint *child_pid,
ChildOutputFunc stdout_handler,
ChildOutputFunc stderr_handler,
gchar **error);
ServerCommandError (* attach) (ServerHandle *handle,
guint32 pid);
ServerCommandError (* detach) (ServerHandle *handle);
void (* finalize) (ServerHandle *handle);
guint32 (* global_wait) (guint32 *status_ret);
ServerCommandError (* stop_and_wait) (ServerHandle *handle,
guint32 *status);
ServerStatusMessageType (* dispatch_event) (ServerHandle *handle,
guint32 status,
guint64 *arg,
guint64 *data1,
guint64 *data2,
guint32 *opt_data_size,
gpointer *opt_data);
/* Get sizeof (int), sizeof (long) and sizeof (void *) from the target. */
ServerCommandError (* get_target_info) (guint32 *target_int_size,
guint32 *target_long_size,
guint32 *target_address_size,
guint32 *is_bigendian);
/*
* Continue the target.
* This operation must start the target and then return immediately
* (without waiting for the target to stop).
*/
ServerCommandError (* run) (ServerHandle *handle);
/*
* Single-step one machine instruction.
* This operation must start the target and then return immediately
* (without waiting for the target to stop).
*/
ServerCommandError (* step) (ServerHandle *handle);
/*
* Get the current program counter.
* Return COMMAND_ERROR_NOT_STOPPED if the target is currently running.
* This is a time-critical function, it must return immediately without blocking.
*/
ServerCommandError (* get_frame) (ServerHandle *handle,
StackFrame *frame);
/*
* Checks whether the current instruction is a breakpoint.
*/
ServerCommandError (* current_insn_is_bpt) (ServerHandle *handle,
guint32 *is_breakpoint);
ServerCommandError (* peek_word) (ServerHandle *handle,
guint64 start,
guint64 *word);
/*
* Read `size' bytes from the target's address space starting at `start'.
* Writes the result into `buffer' (which has been allocated by the caller).
*/
ServerCommandError (* read_memory) (ServerHandle *handle,
guint64 start,
guint32 size,
gpointer buffer);
/*
* Write `size' bytes from `buffer' to the target's address space starting at `start'.
*/
ServerCommandError (* write_memory) (ServerHandle *handle,
guint64 start,
guint32 size,
gconstpointer data);
/*
* Call `guint64 (*func) (guint64)' function at address `method' in the target address
* space, pass it argument `method_argument', send a MESSAGE_CHILD_CALLBACK with the
* `callback_argument' and the function's return value when the function returns.
* This function must return immediately without waiting for the target !
*/
ServerCommandError (* call_method) (ServerHandle *handle,
guint64 method,
guint64 method_argument1,
guint64 method_argument2,
guint64 callback_argument);
/*
* Call `guint64 (*func) (guint64, const gchar *)' function at address `method' in the
* target address space, pass it arguments `method_argument' and `string_argument' , send
* a MESSAGE_CHILD_CALLBACK with the `callback_argument' and the function's return value
* when the function returns.
* This function must return immediately without waiting for the target !
*/
ServerCommandError (* call_method_1) (ServerHandle *handle,
guint64 method,
guint64 method_argument,
guint64 data_argument,
guint64 data_argument2,
const gchar *string_argument,
guint64 callback_argument);
ServerCommandError (* call_method_2) (ServerHandle *handle,
guint64 method,
guint32 data_size,
gconstpointer data_buffer,
guint64 callback_argument);
ServerCommandError (* call_method_invoke) (ServerHandle *handle,
guint64 invoke_method,
guint64 method_argument,
guint32 num_params,
guint32 glob_size,
guint64 *param_data,
gint32 *offset_data,
gconstpointer blob_data,
guint64 callback_argument,
gboolean debug);
ServerCommandError (* execute_instruction) (ServerHandle *handle,
const guint8 *instruction,
guint32 size,
gboolean update_ip);
ServerCommandError (* mark_rti_frame) (ServerHandle *handle);
ServerCommandError (* abort_invoke) (ServerHandle *handle,
guint64 stack_pointer);
/*
* Insert a breakpoint at address `address' in the target's address space.
* Returns a breakpoint handle in `bhandle' which can be passed to `remove_breakpoint'
* to remove the breakpoint.
*/
ServerCommandError (* insert_breakpoint) (ServerHandle *handle,
guint64 address,
guint32 *bhandle);
/*
* Insert a hardware breakpoint at address `address' in the target's address space.
* Returns a breakpoint handle in `bhandle' which can be passed to `remove_breakpoint'
* to remove the breakpoint.
*/
ServerCommandError (* insert_hw_breakpoint)(ServerHandle *handle,
guint32 type,
guint32 *idx,
guint64 address,
guint32 *bhandle);
/*
* Remove breakpoint `bhandle'.
*/
ServerCommandError (* remove_breakpoint) (ServerHandle *handle,
guint32 bhandle);
/*
* Enables breakpoint `bhandle'.
*/
ServerCommandError (* enable_breakpoint) (ServerHandle *handle,
guint32 bhandle);
/*
* Disables breakpoint `bhandle'.
*/
ServerCommandError (* disable_breakpoint) (ServerHandle *handle,
guint32 bhandle);
/*
* Get all breakpoints. Writes number of breakpoints into `count' and returns a g_new0()
* allocated list of guint32's in `breakpoints'. The caller is responsible for freeing this
* data structure.
*/
ServerCommandError (* get_breakpoints) (ServerHandle *handle,
guint32 *count,
guint32 **breakpoints);
/*
* Get processor registers.
*
*/
ServerCommandError (* get_registers) (ServerHandle *handle,
guint64 *values);
/*
* Set processor registers.
*
*/
ServerCommandError (* set_registers) (ServerHandle *handle,
guint64 *values);
/*
* Stop the target.
*/
ServerCommandError (* stop) (ServerHandle *handle);
/*
* Send signal `sig' to the target the next time it is continued.
*/
ServerCommandError (* set_signal) (ServerHandle *handle,
guint32 sig,
guint32 send_it);
/*
* Kill the target.
*/
ServerCommandError (* kill) (ServerHandle *handle);
ServerCommandError (* get_signal_info) (ServerHandle *handle,
SignalInfo **sinfo);
ServerCommandError (* get_threads) (ServerHandle *handle,
guint32 *count,
guint32 **threads);
ServerCommandError (* get_application) (ServerHandle *handle,
gchar **exe_file,
gchar **cwd,
guint32 *nargs,
gchar ***cmdline_args);
ServerCommandError (* detach_after_fork) (ServerHandle *handle);
ServerCommandError (* push_registers) (ServerHandle *handle,
guint64 *new_rsp);
ServerCommandError (* pop_registers) (ServerHandle *handle);
ServerCommandError (* get_callback_frame) (ServerHandle *handle,
guint64 stack_pointer,
gboolean exact_match,
guint64 *registers);
};
/*
* Library functions.
*
* These functions just call the corresponding function in the ServerHandle's vtable.
* They're just here to be called from C#.
*/
void
mono_debugger_server_static_init (void);
void
mono_debugger_server_global_init (void);
ServerHandle *
mono_debugger_server_create_inferior (BreakpointManager *bpm);
ServerCommandError
mono_debugger_server_initialize_process (ServerHandle *handle);
ServerCommandError
mono_debugger_server_initialize_thread (ServerHandle *handle,
guint32 pid);
ServerCommandError
mono_debugger_server_spawn (ServerHandle *handle,
const gchar *working_directory,
const gchar **argv,
const gchar **envp,
gint *child_pid,
ChildOutputFunc stdout_handler,
ChildOutputFunc stderr_handler,
gchar **error);
ServerCommandError
mono_debugger_server_attach (ServerHandle *handle,
guint32 pid);
void
mono_debugger_server_finalize (ServerHandle *handle);
guint32
mono_debugger_server_global_wait (guint32 *status);
ServerStatusMessageType
mono_debugger_server_dispatch_event (ServerHandle *handle,
guint32 status,
guint64 *arg,
guint64 *data1,
guint64 *data2,
guint32 *opt_data_size,
gpointer *opt_data);
ServerCommandError
mono_debugger_server_get_target_info (guint32 *target_int_size,
guint32 *target_long_size,
guint32 *target_address_size,
guint32 *is_bigendian);
ServerCommandError
mono_debugger_server_get_frame (ServerHandle *handle,
StackFrame *frame);
ServerCommandError
mono_debugger_server_current_insn_is_bpt (ServerHandle *handle,
guint32 *is_breakpoint);
ServerCommandError
mono_debugger_server_step (ServerHandle *handle);
ServerCommandError
mono_debugger_server_continue (ServerHandle *handle);
ServerCommandError
mono_debugger_server_detach (ServerHandle *handle);
ServerCommandError
mono_debugger_server_peek_word (ServerHandle *handle,
guint64 start,
guint64 *word);
ServerCommandError
mono_debugger_server_read_memory (ServerHandle *handle,
guint64 start,
guint32 size,
gpointer data);
ServerCommandError
mono_debugger_server_write_memory (ServerHandle *handle,
guint64 start,
guint32 size,
gconstpointer data);
ServerCommandError
mono_debugger_server_call_method (ServerHandle *handle,
guint64 method_address,
guint64 method_argument1,
guint64 method_argument2,
guint64 callback_argument);
ServerCommandError
mono_debugger_server_call_method_1 (ServerHandle *handle,
guint64 method_address,
guint64 method_argument,
guint64 data_argument,
guint64 data_argument2,
const gchar *string_argument,
guint64 callback_argument);
ServerCommandError
mono_debugger_server_call_method_2 (ServerHandle *handle,
guint64 method_address,
guint32 data_size,
gconstpointer data_buffer,
guint64 callback_argument);
ServerCommandError
mono_debugger_server_call_method_invoke (ServerHandle *handle,
guint64 invoke_method,
guint64 method_argument,
guint32 num_params,
guint32 blob_size,
guint64 *param_data,
gint32 *offset_data,
gconstpointer blob_data,
guint64 callback_argument,
gboolean debug);
ServerCommandError
mono_debugger_execute_instruction (ServerHandle *handle,
const guint8 *instruction,
guint32 instruction_size,
gboolean update_ip);
ServerCommandError
mono_debugger_mark_rti_framenvoke (ServerHandle *handle);
ServerCommandError
mono_debugger_server_abort_invoke (ServerHandle *handle,
guint64 stack_pointer);
ServerCommandError
mono_debugger_server_insert_breakpoint (ServerHandle *handle,
guint64 address,
guint32 *breakpoint);
ServerCommandError
mono_debugger_server_insert_hw_breakpoint(ServerHandle *handle,
guint32 type,
guint32 *idx,
guint64 address,
guint32 *breakpoint);
ServerCommandError
mono_debugger_server_remove_breakpoint (ServerHandle *handle,
guint32 breakpoint);
ServerCommandError
mono_debugger_server_enable_breakpoint (ServerHandle *handle,
guint32 breakpoint);
ServerCommandError
mono_debugger_server_disable_breakpoint (ServerHandle *handle,
guint32 breakpoint);
ServerCommandError
mono_debugger_server_get_registers (ServerHandle *handle,
guint64 *values);
ServerCommandError
mono_debugger_server_set_registers (ServerHandle *handle,
guint64 *values);
ServerCommandError
mono_debugger_server_stop (ServerHandle *handle);
ServerCommandError
mono_debugger_server_stop_and_wait (ServerHandle *handle,
guint32 *status);
ServerCommandError
mono_debugger_server_set_signal (ServerHandle *handle,
guint32 sig,
guint32 send_it);
ServerCommandError
mono_debugger_server_kill (ServerHandle *handle);
ServerCommandError
mono_debugger_server_get_signal_info (ServerHandle *handle,
SignalInfo **sinfo);
void
mono_debugger_server_set_runtime_info (ServerHandle *handle,
MonoRuntimeInfo *mono_runtime);
ServerCommandError
mono_debugger_server_get_threads (ServerHandle *handle,
guint32 *count,
guint32 **threads);
ServerCommandError
mono_debugger_server_get_application (ServerHandle *handle,
gchar **exe_file,
gchar **cwd,
guint32 *nargs,
gchar ***cmdline_args);
ServerCommandError
mono_debugger_server_detach_after_fork (ServerHandle *handle);
ServerCommandError
mono_debugger_server_push_registers (ServerHandle *handle,
guint64 *new_rsp);
ServerCommandError
mono_debugger_server_pop_registers (ServerHandle *handle);
ServerCommandError
mono_debugger_server_get_callback_frame (ServerHandle *handle,
guint64 stack_pointer,
gboolean exact_match,
guint64 *registers);
MonoRuntimeInfo *
mono_debugger_server_initialize_mono_runtime (guint32 address_size,
guint64 notification_address,
guint64 executable_code_buffer,
guint32 executable_code_buffer_size,
guint64 breakpoint_info_area,
guint64 breakpoint_table,
guint32 breakpoint_table_size);
void
mono_debugger_server_finalize_mono_runtime (MonoRuntimeInfo *runtime);
/* POSIX semaphores */
void mono_debugger_server_sem_init (void);
void mono_debugger_server_sem_wait (void);
void mono_debugger_server_sem_post (void);
int mono_debugger_server_sem_get_value (void);
guint32 mono_debugger_server_get_current_pid (void);
guint64 mono_debugger_server_get_current_thread (void);
int mono_debugger_server_get_pending_sigint (void);
G_END_DECLS
#endif
|
