gdb_server.c 54.4 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 yvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
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
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "replacements.h"

#include "gdb_server.h"

#include "server.h"
#include "log.h"
#include "binarybuffer.h"
#include "jtag.h"
#include "breakpoints.h"
#include "flash.h"
#include "target_request.h"
#include "configuration.h"

#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <stdlib.h>

#if 0
#define _DEBUG_GDB_IO_
#endif

49
50
51
static int gdb_breakpoint_override;
static enum breakpoint_type gdb_breakpoint_override_type;

52
extern int gdb_error(connection_t *connection, int retval);
53
54
55
static unsigned short gdb_port;
static const char *DIGITS = "0123456789abcdef";

ntfreak's avatar
ntfreak committed
56
static void gdb_log_callback(void *priv, const char *file, int line,
57
		const char *function, const char *string);
58
59
60
61
62
63
64
65
66
67
68
69
70
71

enum gdb_detach_mode
{
	GDB_DETACH_RESUME,
	GDB_DETACH_RESET,
	GDB_DETACH_HALT,
	GDB_DETACH_NOTHING
};

/* target behaviour on gdb detach */
enum gdb_detach_mode detach_mode = GDB_DETACH_RESUME;

/* set if we are sending a memory map to gdb
 * via qXfer:memory-map:read packet */
72
73
74
75
/* enabled by default*/
int gdb_use_memory_map = 1;
/* enabled by default*/
int gdb_flash_program = 1;
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

/* if set, data aborts cause an error to be reported in memory read packets
 * see the code in gdb_read_memory_packet() for further explanations */
int gdb_report_data_abort = 0;

int gdb_last_signal(target_t *target)
{
	switch (target->debug_reason)
	{
		case DBG_REASON_DBGRQ:
			return 0x2; /* SIGINT */
		case DBG_REASON_BREAKPOINT:
		case DBG_REASON_WATCHPOINT:
		case DBG_REASON_WPTANDBKPT:
			return 0x05; /* SIGTRAP */
		case DBG_REASON_SINGLESTEP:
			return 0x05; /* SIGTRAP */
		case DBG_REASON_NOTHALTED:
			return 0x0; /* no signal... shouldn't happen */
		default:
96
			LOG_USER("undefined debug reason %d - target needs reset", target->debug_reason);
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
			return 0x0;
	}
}

int check_pending(connection_t *connection, int timeout_s, int *got_data)
{
	/* a non-blocking socket will block if there is 0 bytes available on the socket,
	 * but return with as many bytes as are available immediately
	 */
	struct timeval tv;
	fd_set read_fds;
	gdb_connection_t *gdb_con = connection->priv;
	int t;
	if (got_data==NULL)
		got_data=&t;
	*got_data=0;

	if (gdb_con->buf_cnt>0)
	{
		*got_data = 1;
		return ERROR_OK;
	}
	
	FD_ZERO(&read_fds);
	FD_SET(connection->fd, &read_fds);
	
	tv.tv_sec = timeout_s;
	tv.tv_usec = 0;
	if (select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0)
	{
		/* This can typically be because a "monitor" command took too long
		 * before printing any progress messages
		 */
		if (timeout_s>0)
		{
			return ERROR_GDB_TIMEOUT;
		} else
		{
			return ERROR_OK;
		}
137
	}
138
139
	*got_data=FD_ISSET(connection->fd, &read_fds)!=0;
	return ERROR_OK;
140
141
142
143
144
}

int gdb_get_char(connection_t *connection, int* next_char)
{
	gdb_connection_t *gdb_con = connection->priv;
145
	int retval=ERROR_OK;
146
147
148
149
150
151
152
153
154
155
156
157
158
159

#ifdef _DEBUG_GDB_IO_
	char *debug_buffer;
#endif

	if (gdb_con->buf_cnt-- > 0)
	{
		*next_char = *(gdb_con->buf_p++);
		if (gdb_con->buf_cnt > 0)
			connection->input_pending = 1;
		else
			connection->input_pending = 0;

#ifdef _DEBUG_GDB_IO_
160
		LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
161
162
163
164
165
166
167
#endif

		return ERROR_OK;
	}

	for (;;)
	{
168
169
170
		retval=check_pending(connection, 1, NULL);
		if (retval!=ERROR_OK)
			return retval;
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
		gdb_con->buf_cnt = read_socket(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
		if (gdb_con->buf_cnt > 0)
		{
			break;
		}
		if (gdb_con->buf_cnt == 0)
		{
			gdb_con->closed = 1;
			return ERROR_SERVER_REMOTE_CLOSED;
		}

#ifdef _WIN32
		errno = WSAGetLastError();

		switch(errno)
		{
			case WSAEWOULDBLOCK:
				usleep(1000);
				break;
			case WSAECONNABORTED:
191
				gdb_con->closed = 1;
192
193
				return ERROR_SERVER_REMOTE_CLOSED;
			case WSAECONNRESET:
194
				gdb_con->closed = 1;
195
196
				return ERROR_SERVER_REMOTE_CLOSED;
			default:
197
				LOG_ERROR("read: %d", errno);
198
199
200
201
202
203
204
205
206
				exit(-1);
		}
#else
		switch(errno)
		{
			case EAGAIN:
				usleep(1000);
				break;
			case ECONNABORTED:
207
				gdb_con->closed = 1;
208
209
				return ERROR_SERVER_REMOTE_CLOSED;
			case ECONNRESET:
210
				gdb_con->closed = 1;
211
212
				return ERROR_SERVER_REMOTE_CLOSED;
			default:
213
				LOG_ERROR("read: %s", strerror(errno));
214
				gdb_con->closed = 1;
215
216
217
218
219
220
221
222
223
				return ERROR_SERVER_REMOTE_CLOSED;
		}
#endif
	}

#ifdef _DEBUG_GDB_IO_
	debug_buffer = malloc(gdb_con->buf_cnt + 1);
	memcpy(debug_buffer, gdb_con->buffer, gdb_con->buf_cnt);
	debug_buffer[gdb_con->buf_cnt] = 0;
224
	LOG_DEBUG("received '%s'", debug_buffer);
225
226
227
228
229
230
231
232
233
	free(debug_buffer);
#endif

	gdb_con->buf_p = gdb_con->buffer;
	gdb_con->buf_cnt--;
	*next_char = *(gdb_con->buf_p++);
	if (gdb_con->buf_cnt > 0)
		connection->input_pending = 1;
	else
ntfreak's avatar
ntfreak committed
234
		connection->input_pending = 0;
235
#ifdef _DEBUG_GDB_IO_
236
	LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
237
238
#endif

239
	return retval;
240
241
242
243
244
245
246
247
248
249
250
251
252
}

int gdb_putback_char(connection_t *connection, int last_char)
{
	gdb_connection_t *gdb_con = connection->priv;

	if (gdb_con->buf_p > gdb_con->buffer)
	{
		*(--gdb_con->buf_p) = last_char;
		gdb_con->buf_cnt++;
	}
	else
	{
253
		LOG_ERROR("BUG: couldn't put character back");
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
	}

	return ERROR_OK;
}

/* The only way we can detect that the socket is closed is the first time
 * we write to it, we will fail. Subsequent write operations will
 * succeed. Shudder! */
int gdb_write(connection_t *connection, void *data, int len)
{
	gdb_connection_t *gdb_con = connection->priv;
	if (gdb_con->closed)
		return ERROR_SERVER_REMOTE_CLOSED;

	if (write_socket(connection->fd, data, len) == len)
	{
		return ERROR_OK;
	}
	gdb_con->closed = 1;
	return ERROR_SERVER_REMOTE_CLOSED;
}

int gdb_put_packet_inner(connection_t *connection, char *buffer, int len)
{
	int i;
	unsigned char my_checksum = 0;
#ifdef _DEBUG_GDB_IO_
	char *debug_buffer;
#endif
	int reply;
	int retval;
	gdb_connection_t *gdb_con = connection->priv;

	for (i = 0; i < len; i++)
		my_checksum += buffer[i];

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
#ifdef _DEBUG_GDB_IO_
	/* 
	 * At this point we should have nothing in the input queue from GDB,
	 * however sometimes '-' is sent even though we've already received
	 * an ACK (+) for everything we've sent off.
	 */
	int gotdata;
	for (;;)
	{
		if ((retval=check_pending(connection, 0, &gotdata))!=ERROR_OK)
			return retval;
		if (!gotdata)
			break;
		if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
			return retval;
305
		LOG_WARNING("Discard unexpected char %c", reply);
306
307
308
	}
#endif

309
310
311
312
313
314
	while (1)
	{
#ifdef _DEBUG_GDB_IO_
		debug_buffer = malloc(len + 1);
		memcpy(debug_buffer, buffer, len);
		debug_buffer[len] = 0;
315
		LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
316
317
		free(debug_buffer);
#endif
ntfreak's avatar
ntfreak committed
318

319
320
321
		char local_buffer[1024];
		local_buffer[0] = '$';
		if (len+4 <= sizeof(local_buffer))
322
		{
323
324
325
326
327
328
			/* performance gain on smaller packets by only a single call to gdb_write() */
			memcpy(local_buffer+1, buffer, len++);
			local_buffer[len++] = '#';
			local_buffer[len++] = DIGITS[(my_checksum >> 4) & 0xf];
			local_buffer[len++] = DIGITS[my_checksum & 0xf];
			gdb_write(connection, local_buffer, len);
329
		}
330
		else
331
		{
332
333
334
335
336
337
338
339
			/* larger packets are transmitted directly from caller supplied buffer
			   by several calls to gdb_write() to avoid dynamic allocation */
			local_buffer[1] = '#';
			local_buffer[2] = DIGITS[(my_checksum >> 4) & 0xf];
			local_buffer[3] = DIGITS[my_checksum & 0xf];
			gdb_write(connection, local_buffer, 1);
			gdb_write(connection, buffer, len);
			gdb_write(connection, local_buffer+1, 3);
340
		}
341
342
343
344
		
		if (gdb_con->noack_mode)
			break;
		
345
346
347
348
349
350
351
352
353
		if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
			return retval;

		if (reply == '+')
			break;
		else if (reply == '-')
		{
			/* Stop sending output packets for now */
			log_remove_callback(gdb_log_callback, connection);
354
			LOG_WARNING("negative reply, retrying");
355
356
357
358
359
360
361
362
363
364
365
366
		}
		else if (reply == 0x3)
		{
			gdb_con->ctrl_c = 1;
			if ((retval = gdb_get_char(connection, &reply)) != ERROR_OK)
				return retval;
			if (reply == '+')
				break;
			else if (reply == '-')
			{
				/* Stop sending output packets for now */
				log_remove_callback(gdb_log_callback, connection);
367
				LOG_WARNING("negative reply, retrying");
368
369
370
			}
			else
			{
371
				LOG_ERROR("unknown character 0x%2.2x in reply, dropping connection", reply);
372
				gdb_con->closed=1;
373
374
375
376
377
				return ERROR_SERVER_REMOTE_CLOSED;
			}
		}
		else
		{
378
			LOG_ERROR("unknown character 0x%2.2x in reply, dropping connection", reply);
379
			gdb_con->closed=1;
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
			return ERROR_SERVER_REMOTE_CLOSED;
		}
	}
	if (gdb_con->closed)
		return ERROR_SERVER_REMOTE_CLOSED;

	return ERROR_OK;
}

int gdb_put_packet(connection_t *connection, char *buffer, int len)
{
	gdb_connection_t *gdb_con = connection->priv;
	gdb_con->busy = 1;
	int retval = gdb_put_packet_inner(connection, buffer, len);
	gdb_con->busy = 0;
	return retval;
}

oharboe's avatar
oharboe committed
398
static __inline__ int fetch_packet(connection_t *connection, int *checksum_ok, int noack, int *len, char *buffer)
399
{
oharboe's avatar
oharboe committed
400
401
	unsigned char my_checksum = 0;
	char checksum[3];
402
	int character;
oharboe's avatar
oharboe committed
403
404
405
406
	int retval;
	
	gdb_connection_t *gdb_con = connection->priv;
	my_checksum = 0;
407
	int count = 0;
oharboe's avatar
oharboe committed
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
	count = 0;
	for (;;)
	{
		/* The common case is that we have an entire packet with no escape chars.
		 * We need to leave at least 2 bytes in the buffer to have
		 * gdb_get_char() update various bits and bobs correctly.
		 */
		if ((gdb_con->buf_cnt > 2) && ((gdb_con->buf_cnt+count) < *len))
		{
			/* The compiler will struggle a bit with constant propagation and
			 * aliasing, so we help it by showing that these values do not
			 * change inside the loop
			 */
			int i;
			char *buf = gdb_con->buf_p;
			int run = gdb_con->buf_cnt - 2;
			i = 0;
			int done = 0;
			while (i < run)
			{
				character = *buf++;
				i++;
				if (character == '#')
				{
					/* Danger! character can be '#' when esc is
					 * used so we need an explicit boolean for done here.
					 */
					done = 1;
					break;
				}

				if (character == '}')
				{
					/* data transmitted in binary mode (X packet)
					 * uses 0x7d as escape character */
					my_checksum += character & 0xff;
					character = *buf++;
					i++;
					my_checksum += character & 0xff;
					buffer[count++] = (character ^ 0x20) & 0xff;
				}
				else
				{
					my_checksum += character & 0xff;
					buffer[count++] = character & 0xff;
				}
			}
			gdb_con->buf_p += i;
			gdb_con->buf_cnt -= i;
			if (done)
				break;
		}
		if (count > *len)
		{
			LOG_ERROR("packet buffer too small");
			return ERROR_GDB_BUFFER_TOO_SMALL;
		}

		if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
			return retval;

		if (character == '#')
			break;

		if (character == '}')
		{
			/* data transmitted in binary mode (X packet)
			 * uses 0x7d as escape character */
			my_checksum += character & 0xff;
			if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
				return retval;
			my_checksum += character & 0xff;
			buffer[count++] = (character ^ 0x20) & 0xff;
		}
		else
		{
			my_checksum += character & 0xff;
			buffer[count++] = character & 0xff;
		}
	}

	*len = count;

	if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
		return retval;
	checksum[0] = character;
	if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
		return retval;
	checksum[1] = character;
	checksum[2] = 0;
	
	if (!noack)
	{
		*checksum_ok=(my_checksum == strtoul(checksum, NULL, 16));
	}
	
	return ERROR_OK;
}

int gdb_get_packet_inner(connection_t *connection, char *buffer, int *len)
{
	int character;
510
511
512
513
514
515
516
517
518
519
520
	int retval;
	gdb_connection_t *gdb_con = connection->priv;

	while (1)
	{
		do
		{
			if ((retval = gdb_get_char(connection, &character)) != ERROR_OK)
				return retval;

#ifdef _DEBUG_GDB_IO_
521
			LOG_DEBUG("character: '%c'", character);
522
523
524
525
526
527
528
#endif

			switch (character)
			{
				case '$':
					break;
				case '+':
529
530
					/* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c)
					 * incase anyone tries to debug why they receive this warning every time */
531
					LOG_WARNING("acknowledgment received, but no packet pending");
532
533
					break;
				case '-':
534
					LOG_WARNING("negative acknowledgment, but no packet pending");
535
536
537
538
539
540
					break;
				case 0x3:
					gdb_con->ctrl_c = 1;
					*len = 0;
					return ERROR_OK;
				default:
541
					LOG_WARNING("ignoring character 0x%x", character);
542
543
544
545
					break;
			}
		} while (character != '$');

ntfreak's avatar
ntfreak committed
546
547


oharboe's avatar
oharboe committed
548
549
550
551
552
553
554
		int checksum_ok;
		/* explicit code expansion here to get faster inlined code in -O3 by not
		 * calculating checksum
		 */
		if (gdb_con->noack_mode)
		{
			if ((retval=fetch_packet(connection, &checksum_ok, 1, len, buffer))!=ERROR_OK)
555
				return retval;
oharboe's avatar
oharboe committed
556
		} else
557
		{
oharboe's avatar
oharboe committed
558
559
			if ((retval=fetch_packet(connection, &checksum_ok, 0, len, buffer))!=ERROR_OK)
				return retval;
560
561
		}

oharboe's avatar
oharboe committed
562
		if (gdb_con->noack_mode)
563
		{
oharboe's avatar
oharboe committed
564
565
			/* checksum is not checked in noack mode */
			break;
566
		}
oharboe's avatar
oharboe committed
567
		if (checksum_ok)
568
		{
oharboe's avatar
oharboe committed
569
			gdb_write(connection, "+", 1);
570
571
			break;
		}
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
	}
	if (gdb_con->closed)
		return ERROR_SERVER_REMOTE_CLOSED;

	return ERROR_OK;
}

int gdb_get_packet(connection_t *connection, char *buffer, int *len)
{
	gdb_connection_t *gdb_con = connection->priv;
	gdb_con->busy = 1;
	int retval = gdb_get_packet_inner(connection, buffer, len);
	gdb_con->busy = 0;
	return retval;
}
ntfreak's avatar
ntfreak committed
587

588
int gdb_output_con(connection_t *connection, const char* line)
589
590
591
592
593
594
{
	char *hex_buffer;
	int i, bin_size;

	bin_size = strlen(line);

595
	hex_buffer = malloc(bin_size*2 + 2);
596
597
	if (hex_buffer == NULL)
		return ERROR_GDB_BUFFER_TOO_SMALL;
598
599
600
601

	hex_buffer[0] = 'O';
	for (i=0; i<bin_size; i++)
		snprintf(hex_buffer + 1 + i*2, 3, "%2.2x", line[i]);
602
	hex_buffer[bin_size*2+1] = 0;
603

604
	gdb_put_packet(connection, hex_buffer, bin_size*2 + 1);
605
606
607
608
609

	free(hex_buffer);
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
610
int gdb_output(struct command_context_s *context, const char* line)
611
612
{
	/* this will be dumped to the log and also sent as an O packet if possible */
613
	LOG_USER_N("%s", line);
614
615
616
617
	return ERROR_OK;
}


618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
static void gdb_frontend_halted(struct target_s *target, connection_t *connection)
{
	gdb_connection_t *gdb_connection = connection->priv;
	
	/* In the GDB protocol when we are stepping or coninuing execution,
	 * we have a lingering reply. Upon receiving a halted event
	 * when we have that lingering packet, we reply to the original
	 * step or continue packet.
	 *
	 * Executing monitor commands can bring the target in and
	 * out of the running state so we'll see lots of TARGET_EVENT_XXX
	 * that are to be ignored.
	 */
	if (gdb_connection->frontend_state == TARGET_RUNNING)
	{
		char sig_reply[4];
		int signal;
		/* stop forwarding log packets! */
		log_remove_callback(gdb_log_callback, connection);

		if (gdb_connection->ctrl_c)
		{
			signal = 0x2;
			gdb_connection->ctrl_c = 0;
		}
		else
		{
			signal = gdb_last_signal(target);
		}

		snprintf(sig_reply, 4, "T%2.2x", signal);
		gdb_put_packet(connection, sig_reply, 3);
		gdb_connection->frontend_state = TARGET_HALTED;
	}
}

654
655
656
657
int gdb_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv)
{
	connection_t *connection = priv;

658
	target_handle_event( target, event );
659
660
661
	switch (event)
	{
		case TARGET_EVENT_HALTED:
662
			gdb_frontend_halted(target, connection);
663
			break;
664
		case TARGET_EVENT_GDB_FLASH_ERASE_START:
665
666
			target_handle_event( target, TARGET_EVENT_OLD_gdb_program_config );
			jtag_execute_queue();
667
668
669
670
671
672
673
			break;
		default:
			break;
	}

	return ERROR_OK;
}
ntfreak's avatar
ntfreak committed
674
675


676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
int gdb_new_connection(connection_t *connection)
{
	gdb_connection_t *gdb_connection = malloc(sizeof(gdb_connection_t));
	gdb_service_t *gdb_service = connection->service->priv;
	int retval;
	int initial_ack;

	connection->priv = gdb_connection;

	/* initialize gdb connection information */
	gdb_connection->buf_p = gdb_connection->buffer;
	gdb_connection->buf_cnt = 0;
	gdb_connection->ctrl_c = 0;
	gdb_connection->frontend_state = TARGET_HALTED;
	gdb_connection->vflash_image = NULL;
	gdb_connection->closed = 0;
	gdb_connection->busy = 0;
693
	gdb_connection->noack_mode = 0;
694
695
696
	
	/* send ACK to GDB for debug request */
	gdb_write(connection, "+", 1);
ntfreak's avatar
ntfreak committed
697

698
699
700
	/* output goes through gdb connection */
	command_set_output_handler(connection->cmd_ctx, gdb_output, connection);

701
702
703
704
705
706
707
	/* we must remove all breakpoints registered to the target as a previous
	 * GDB session could leave dangling breakpoints if e.g. communication 
	 * timed out.
	 */
	breakpoint_clear_target(gdb_service->target);
	watchpoint_clear_target(gdb_service->target);
	
708
	/* register callback to be informed about target events */
ntfreak's avatar
ntfreak committed
709
	target_register_event_callback(gdb_target_callback_event_handler, connection);
710

711
	/* a gdb session just attached, try to put the target in halt mode.
oharboe's avatar
   
oharboe committed
712
713
	 * 
	 * DANGER!!!! 
714
715
716
717
718
719
720
721
722
723
724
725
	 * 
	 * If the halt fails(e.g. target needs a reset, JTAG communication not
	 * working, etc.), then the GDB connect will succeed as
	 * the get_gdb_reg_list() will lie and return a register list with
	 * dummy values.
	 * 
	 * This allows GDB monitor commands to be run from a GDB init script to
	 * initialize the target
	 * 
	 * Also, since the halt() is asynchronous target connect will be
	 * instantaneous and thus avoiding annoying timeout problems during
	 * connect. 
726
	 */
727
	target_halt(gdb_service->target);
728
729
730
731
732
733
	/* FIX!!!! could extended-remote work better here?
	 * 
	 *  wait a tiny bit for halted state or we just continue. The
	 * GDB register packet will then contain garbage 
	 */
	target_wait_state(gdb_service->target, TARGET_HALTED, 500);
734
	
735
736
737
738
	/* remove the initial ACK from the incoming buffer */
	if ((retval = gdb_get_char(connection, &initial_ack)) != ERROR_OK)
		return retval;

739
740
741
	/* FIX!!!??? would we actually ever receive a + here??? 
	 * Not observed.
	 */
742
743
	if (initial_ack != '+')
		gdb_putback_char(connection, initial_ack);
744
	target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH );
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
	return ERROR_OK;
}

int gdb_connection_closed(connection_t *connection)
{
	gdb_service_t *gdb_service = connection->service->priv;
	gdb_connection_t *gdb_connection = connection->priv;

	/* see if an image built with vFlash commands is left */
	if (gdb_connection->vflash_image)
	{
		image_close(gdb_connection->vflash_image);
		free(gdb_connection->vflash_image);
		gdb_connection->vflash_image = NULL;
	}

	/* if this connection registered a debug-message receiver delete it */
	delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target);
ntfreak's avatar
ntfreak committed
763

764
765
766
767
768
769
770
	if (connection->priv)
	{
		free(connection->priv);
		connection->priv = NULL;
	}
	else
	{
771
		LOG_ERROR("BUG: connection->priv == NULL");
772
773
774
775
776
	}

	target_unregister_event_callback(gdb_target_callback_event_handler, connection);
	log_remove_callback(gdb_log_callback, connection);

777
	target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH );
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
	return ERROR_OK;
}

void gdb_send_error(connection_t *connection, u8 the_error)
{
	char err[4];
	snprintf(err, 4, "E%2.2X", the_error );
	gdb_put_packet(connection, err, 3);
}

int gdb_last_signal_packet(connection_t *connection, target_t *target, char* packet, int packet_size)
{
	char sig_reply[4];
	int signal;

	signal = gdb_last_signal(target);

	snprintf(sig_reply, 4, "S%2.2x", signal);
	gdb_put_packet(connection, sig_reply, 3);

	return ERROR_OK;
}

/* Convert register to string of bits. NB! The # of bits in the
 * register might be non-divisible by 8(a byte), in which
 * case an entire byte is shown. */
void gdb_str_to_target(target_t *target, char *tstr, reg_t *reg)
{
	int i;

	u8 *buf;
	int buf_len;
	buf = reg->value;
ntfreak's avatar
ntfreak committed
811
	buf_len = CEIL(reg->size, 8);
812

oharboe's avatar
   
oharboe committed
813
	for (i = 0; i < buf_len; i++)
814
	{
oharboe's avatar
   
oharboe committed
815
816
		tstr[i*2]   = DIGITS[(buf[i]>>4) & 0xf];
		tstr[i*2+1] = DIGITS[buf[i]&0xf];
ntfreak's avatar
ntfreak committed
817
	}
818
819
820
821
822
823
824
825
826
}

void gdb_target_to_str(target_t *target, char *tstr, char *str)
{
	int str_len = strlen(tstr);
	int i;

	if (str_len % 2)
	{
827
		LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
828
829
830
		exit(-1);
	}

oharboe's avatar
   
oharboe committed
831
	for (i = 0; i < str_len; i+=2)
832
	{
oharboe's avatar
   
oharboe committed
833
834
		str[str_len - i - 1] = tstr[i + 1];
		str[str_len - i - 2] = tstr[i];
ntfreak's avatar
ntfreak committed
835
	}
836
837
838
839
840
841
842
843
844
845
846
847
848
}

int gdb_get_registers_packet(connection_t *connection, target_t *target, char* packet, int packet_size)
{
	reg_t **reg_list;
	int reg_list_size;
	int retval;
	int reg_packet_size = 0;
	char *reg_packet;
	char *reg_packet_p;
	int i;

#ifdef _DEBUG_GDB_IO_
849
	LOG_DEBUG("-");
850
851
852
853
#endif

	if ((retval = target->type->get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
	{
854
		return gdb_error(connection, retval);
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
	}

	for (i = 0; i < reg_list_size; i++)
	{
		reg_packet_size += reg_list[i]->size;
	}

	reg_packet = malloc(CEIL(reg_packet_size, 8) * 2);
	reg_packet_p = reg_packet;

	for (i = 0; i < reg_list_size; i++)
	{
		gdb_str_to_target(target, reg_packet_p, reg_list[i]);
		reg_packet_p += CEIL(reg_list[i]->size, 8) * 2;
	}

#ifdef _DEBUG_GDB_IO_
	{
		char *reg_packet_p;
		reg_packet_p = strndup(reg_packet, CEIL(reg_packet_size, 8) * 2);
875
		LOG_DEBUG("reg_packet: %s", reg_packet_p);
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
		free(reg_packet_p);
	}
#endif

	gdb_put_packet(connection, reg_packet, CEIL(reg_packet_size, 8) * 2);
	free(reg_packet);

	free(reg_list);

	return ERROR_OK;
}

int gdb_set_registers_packet(connection_t *connection, target_t *target, char *packet, int packet_size)
{
	int i;
	reg_t **reg_list;
	int reg_list_size;
	int retval;
	char *packet_p;

#ifdef _DEBUG_GDB_IO_
897
	LOG_DEBUG("-");
898
899
900
901
902
903
904
905
#endif

	/* skip command character */
	packet++;
	packet_size--;

	if (packet_size % 2)
	{
906
		LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
907
908
909
910
911
		return ERROR_SERVER_REMOTE_CLOSED;
	}

	if ((retval = target->type->get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
	{
912
		return gdb_error(connection, retval);
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
	}

	packet_p = packet;
	for (i = 0; i < reg_list_size; i++)
	{
		u8 *bin_buf;
		char *hex_buf;
		reg_arch_type_t *arch_type;

		/* convert from GDB-string (target-endian) to hex-string (big-endian) */
		hex_buf = malloc(CEIL(reg_list[i]->size, 8) * 2);
		gdb_target_to_str(target, packet_p, hex_buf);

		/* convert hex-string to binary buffer */
		bin_buf = malloc(CEIL(reg_list[i]->size, 8));
		str_to_buf(hex_buf, CEIL(reg_list[i]->size, 8) * 2, bin_buf, reg_list[i]->size, 16);

ntfreak's avatar
ntfreak committed
930
		/* get register arch_type, and call set method */
931
932
933
		arch_type = register_get_arch_type(reg_list[i]->arch_type);
		if (arch_type == NULL)
		{
934
			LOG_ERROR("BUG: encountered unregistered arch type");
935
936
937
938
			exit(-1);
		}
		arch_type->set(reg_list[i], bin_buf);

ntfreak's avatar
ntfreak committed
939
		/* advance packet pointer */
940
941
942
943
944
945
		packet_p += (CEIL(reg_list[i]->size, 8) * 2);

		free(bin_buf);
		free(hex_buf);
	}

ntfreak's avatar
ntfreak committed
946
	/* free reg_t *reg_list[] array allocated by get_gdb_reg_list */
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
	free(reg_list);

	gdb_put_packet(connection, "OK", 2);

	return ERROR_OK;
}

int gdb_get_register_packet(connection_t *connection, target_t *target, char *packet, int packet_size)
{
	char *reg_packet;
	int reg_num = strtoul(packet + 1, NULL, 16);
	reg_t **reg_list;
	int reg_list_size;
	int retval;

#ifdef _DEBUG_GDB_IO_
963
	LOG_DEBUG("-");
964
965
966
967
#endif

	if ((retval = target->type->get_gdb_reg_list(target, &reg_list, &reg_list_size)) != ERROR_OK)
	{
968
		return gdb_error(connection, retval);
969
970
971
972
	}

	if (reg_list_size <= reg_num)
	{
973
		LOG_ERROR("gdb requested a non-existing register");
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
		exit(-1);
	}

	reg_packet = malloc(CEIL(reg_list[reg_num]->size, 8) * 2);

	gdb_str_to_target(target, reg_packet, reg_list[reg_num]);

	gdb_put_packet(connection, reg_packet, CEIL(reg_list[reg_num]->size, 8) * 2);

	free(reg_list);
	free(reg_packet);

	return ERROR_OK;
}

int gdb_set_register_packet(connection_t *connection, target_t *target, char *packet, int packet_size)
{
	char *separator;
	char *hex_buf;
	u8 *bin_buf;
	int reg_num = strtoul(packet + 1, &separator, 16);
	reg_t **reg_list;
	int reg_list_size;
	int retval;
	reg_arch_type_t *arch_type;

1000
	LOG_DEBUG("-");
For faster browsing, not all history is shown. View entire blame