src/server/gdb_server.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   Copyright (C) 2011 by Broadcom Corporation                            *
  12  *   Evan Hunter - ehunter@broadcom.com                                    *
  13  *                                                                         *
  14  *   Copyright (C) ST-Ericsson SA 2011                                     *
  15  *   michel.jaouen@stericsson.com : smp minimum support                    *
  16  *                                                                         *
  17  *   This program is free software; you can redistribute it and/or modify  *
  18  *   it under the terms of the GNU General Public License as published by  *
  19  *   the Free Software Foundation; either version 2 of the License, or     *
  20  *   (at your option) any later version.                                   *
  21  *                                                                         *
  22  *   This program is distributed in the hope that it will be useful,       *
  23  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  24  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  25  *   GNU General Public License for more details.                          *
  26  *                                                                         *
  27  *   You should have received a copy of the GNU General Public License     *
  28  *   along with this program; if not, write to the                         *
  29  *   Free Software Foundation, Inc.,                                       *
  30  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  31  ***************************************************************************/
  32
  33 #ifdef HAVE_CONFIG_H
  34 #include "config.h"
  35 #endif
  36
  37 #include <target/breakpoints.h>
  38 #include <target/target_request.h>
  39 #include <target/register.h>
  40 #include "server.h"
  41 #include <flash/nor/core.h>
  42 #include "gdb_server.h"
  43 #include <target/image.h>
  44 #include <jtag/jtag.h>
  45 #include "rtos/rtos.h"
  46 #include "target/smp.h"
  47
  48 /**
  49  * @file
  50  * GDB server implementation.
  51  *
  52  * This implements the GDB Remote Serial Protocol, over TCP connections,
  53  * giving GDB access to the JTAG or other hardware debugging facilities
  54  * found in most modern embedded processors.
  55  */
  56
  57 /* private connection data for GDB */
  58 struct gdb_connection {
  59         char buffer[GDB_BUFFER_SIZE];
  60         char *buf_p;
  61         int buf_cnt;
  62         int ctrl_c;
  63         enum target_state frontend_state;
  64         struct image *vflash_image;
  65         int closed;
  66         int busy;
  67         int noack_mode;
  68         /* set flag to true if you want the next stepi to return immediately.
  69          * allowing GDB to pick up a fresh set of register values from the target
  70          * without modifying the target state. */
  71         bool sync;
  72         /* We delay reporting memory write errors until next step/continue or memory
  73          * write. This improves performance of gdb load significantly as the GDB packet
  74          * can be replied immediately and a new GDB packet will be ready without delay
  75          * (ca. 10% or so...). */
  76         bool mem_write_error;
  77         /* with extended-remote it seems we need to better emulate attach/detach.
  78          * what this means is we reply with a W stop reply after a kill packet,
  79          * normally we reply with a S reply via gdb_last_signal_packet.
  80          * as a side note this behaviour only effects gdb > 6.8 */
  81         bool attached;
  82 };
  83
  84 #if 0
  85 #define _DEBUG_GDB_IO_
  86 #endif
  87
  88 static struct gdb_connection *current_gdb_connection;
  89
  90 static int gdb_breakpoint_override;
  91 static enum breakpoint_type gdb_breakpoint_override_type;
  92
  93 static int gdb_error(struct connection *connection, int retval);
  94 static const char *gdb_port;
  95 static const char *gdb_port_next;
  96
  97 static void gdb_log_callback(void *priv, const char *file, unsigned line,
  98                 const char *function, const char *string);
  99
 100 /* number of gdb connections, mainly to suppress gdb related debugging spam
 101  * in helper/log.c when no gdb connections are actually active */
 102 int gdb_actual_connections;
 103
 104 /* set if we are sending a memory map to gdb
 105  * via qXfer:memory-map:read packet */
 106 /* enabled by default*/
 107 static int gdb_use_memory_map = 1;
 108 /* enabled by default*/
 109 static int gdb_flash_program = 1;
 110
 111 /* if set, data aborts cause an error to be reported in memory read packets
 112  * see the code in gdb_read_memory_packet() for further explanations.
 113  * Disabled by default.
 114  */
 115 static int gdb_report_data_abort;
 116
 117 static int gdb_last_signal(struct target *target)
 118 {
 119         switch (target->debug_reason) {
 120                 case DBG_REASON_DBGRQ:
 121                         return 0x2;             /* SIGINT */
 122                 case DBG_REASON_BREAKPOINT:
 123                 case DBG_REASON_WATCHPOINT:
 124                 case DBG_REASON_WPTANDBKPT:
 125                         return 0x05;    /* SIGTRAP */
 126                 case DBG_REASON_SINGLESTEP:
 127                         return 0x05;    /* SIGTRAP */
 128                 case DBG_REASON_NOTHALTED:
 129                         return 0x0;             /* no signal... shouldn't happen */
 130                 default:
 131                         LOG_USER("undefined debug reason %d - target needs reset",
 132                                         target->debug_reason);
 133                         return 0x0;
 134         }
 135 }
 136
 137 static int check_pending(struct connection *connection,
 138                 int timeout_s, int *got_data)
 139 {
 140         /* a non-blocking socket will block if there is 0 bytes available on the socket,
 141          * but return with as many bytes as are available immediately
 142          */
 143         struct timeval tv;
 144         fd_set read_fds;
 145         struct gdb_connection *gdb_con = connection->priv;
 146         int t;
 147         if (got_data == NULL)
 148                 got_data = &t;
 149         *got_data = 0;
 150
 151         if (gdb_con->buf_cnt > 0) {
 152                 *got_data = 1;
 153                 return ERROR_OK;
 154         }
 155
 156         FD_ZERO(&read_fds);
 157         FD_SET(connection->fd, &read_fds);
 158
 159         tv.tv_sec = timeout_s;
 160         tv.tv_usec = 0;
 161         if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) {
 162                 /* This can typically be because a "monitor" command took too long
 163                  * before printing any progress messages
 164                  */
 165                 if (timeout_s > 0)
 166                         return ERROR_GDB_TIMEOUT;
 167                 else
 168                         return ERROR_OK;
 169         }
 170         *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
 171         return ERROR_OK;
 172 }
 173
 174 static int gdb_get_char_inner(struct connection *connection, int *next_char)
 175 {
 176         struct gdb_connection *gdb_con = connection->priv;
 177         int retval = ERROR_OK;
 178
 179 #ifdef _DEBUG_GDB_IO_
 180         char *debug_buffer;
 181 #endif
 182         for (;; ) {
 183                 if (connection->service->type != CONNECTION_TCP)
 184                         gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
 185                 else {
 186                         retval = check_pending(connection, 1, NULL);
 187                         if (retval != ERROR_OK)
 188                                 return retval;
 189                         gdb_con->buf_cnt = read_socket(connection->fd,
 190                                         gdb_con->buffer,
 191                                         GDB_BUFFER_SIZE);
 192                 }
 193
 194                 if (gdb_con->buf_cnt > 0)
 195                         break;
 196                 if (gdb_con->buf_cnt == 0) {
 197                         gdb_con->closed = 1;
 198                         return ERROR_SERVER_REMOTE_CLOSED;
 199                 }
 200
 201 #ifdef _WIN32
 202                 errno = WSAGetLastError();
 203
 204                 switch (errno) {
 205                         case WSAEWOULDBLOCK:
 206                                 usleep(1000);
 207                                 break;
 208                         case WSAECONNABORTED:
 209                                 gdb_con->closed = 1;
 210                                 return ERROR_SERVER_REMOTE_CLOSED;
 211                         case WSAECONNRESET:
 212                                 gdb_con->closed = 1;
 213                                 return ERROR_SERVER_REMOTE_CLOSED;
 214                         default:
 215                                 LOG_ERROR("read: %d", errno);
 216                                 exit(-1);
 217                 }
 218 #else
 219                 switch (errno) {
 220                         case EAGAIN:
 221                                 usleep(1000);
 222                                 break;
 223                         case ECONNABORTED:
 224                                 gdb_con->closed = 1;
 225                                 return ERROR_SERVER_REMOTE_CLOSED;
 226                         case ECONNRESET:
 227                                 gdb_con->closed = 1;
 228                                 return ERROR_SERVER_REMOTE_CLOSED;
 229                         default:
 230                                 LOG_ERROR("read: %s", strerror(errno));
 231                                 gdb_con->closed = 1;
 232                                 return ERROR_SERVER_REMOTE_CLOSED;
 233                 }
 234 #endif
 235         }
 236
 237 #ifdef _DEBUG_GDB_IO_
 238         debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt);
 239         LOG_DEBUG("received '%s'", debug_buffer);
 240         free(debug_buffer);
 241 #endif
 242
 243         gdb_con->buf_p = gdb_con->buffer;
 244         gdb_con->buf_cnt--;
 245         *next_char = *(gdb_con->buf_p++);
 246         if (gdb_con->buf_cnt > 0)
 247                 connection->input_pending = 1;
 248         else
 249                 connection->input_pending = 0;
 250 #ifdef _DEBUG_GDB_IO_
 251         LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 252 #endif
 253
 254         return retval;
 255 }
 256
 257 /**
 258  * The cool thing about this fn is that it allows buf_p and buf_cnt to be
 259  * held in registers in the inner loop.
 260  *
 261  * For small caches and embedded systems this is important!
 262  */
 263 static inline int gdb_get_char_fast(struct connection *connection,
 264                 int *next_char, char **buf_p, int *buf_cnt)
 265 {
 266         int retval = ERROR_OK;
 267
 268         if ((*buf_cnt)-- > 0) {
 269                 *next_char = **buf_p;
 270                 (*buf_p)++;
 271                 if (*buf_cnt > 0)
 272                         connection->input_pending = 1;
 273                 else
 274                         connection->input_pending = 0;
 275
 276 #ifdef _DEBUG_GDB_IO_
 277                 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 278 #endif
 279
 280                 return ERROR_OK;
 281         }
 282
 283         struct gdb_connection *gdb_con = connection->priv;
 284         gdb_con->buf_p = *buf_p;
 285         gdb_con->buf_cnt = *buf_cnt;
 286         retval = gdb_get_char_inner(connection, next_char);
 287         *buf_p = gdb_con->buf_p;
 288         *buf_cnt = gdb_con->buf_cnt;
 289
 290         return retval;
 291 }
 292
 293 static int gdb_get_char(struct connection *connection, int *next_char)
 294 {
 295         struct gdb_connection *gdb_con = connection->priv;
 296         return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
 297 }
 298
 299 static int gdb_putback_char(struct connection *connection, int last_char)
 300 {
 301         struct gdb_connection *gdb_con = connection->priv;
 302
 303         if (gdb_con->buf_p > gdb_con->buffer) {
 304                 *(--gdb_con->buf_p) = last_char;
 305                 gdb_con->buf_cnt++;
 306         } else
 307                 LOG_ERROR("BUG: couldn't put character back");
 308
 309         return ERROR_OK;
 310 }
 311
 312 /* The only way we can detect that the socket is closed is the first time
 313  * we write to it, we will fail. Subsequent write operations will
 314  * succeed. Shudder! */
 315 static int gdb_write(struct connection *connection, void *data, int len)
 316 {
 317         struct gdb_connection *gdb_con = connection->priv;
 318         if (gdb_con->closed)
 319                 return ERROR_SERVER_REMOTE_CLOSED;
 320
 321         if (connection_write(connection, data, len) == len)
 322                 return ERROR_OK;
 323         gdb_con->closed = 1;
 324         return ERROR_SERVER_REMOTE_CLOSED;
 325 }
 326
 327 static int gdb_put_packet_inner(struct connection *connection,
 328                 char *buffer, int len)
 329 {
 330         int i;
 331         unsigned char my_checksum = 0;
 332 #ifdef _DEBUG_GDB_IO_
 333         char *debug_buffer;
 334 #endif
 335         int reply;
 336         int retval;
 337         struct gdb_connection *gdb_con = connection->priv;
 338
 339         for (i = 0; i < len; i++)
 340                 my_checksum += buffer[i];
 341
 342 #ifdef _DEBUG_GDB_IO_
 343         /*
 344          * At this point we should have nothing in the input queue from GDB,
 345          * however sometimes '-' is sent even though we've already received
 346          * an ACK (+) for everything we've sent off.
 347          */
 348         int gotdata;
 349         for (;; ) {
 350                 retval = check_pending(connection, 0, &gotdata);
 351                 if (retval != ERROR_OK)
 352                         return retval;
 353                 if (!gotdata)
 354                         break;
 355                 retval = gdb_get_char(connection, &reply);
 356                 if (retval != ERROR_OK)
 357                         return retval;
 358                 if (reply == '$') {
 359                         /* fix a problem with some IAR tools */
 360                         gdb_putback_char(connection, reply);
 361                         LOG_DEBUG("Unexpected start of new packet");
 362                         break;
 363                 }
 364
 365                 LOG_WARNING("Discard unexpected char %c", reply);
 366         }
 367 #endif
 368
 369         while (1) {
 370 #ifdef _DEBUG_GDB_IO_
 371                 debug_buffer = strndup(buffer, len);
 372                 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
 373                 free(debug_buffer);
 374 #endif
 375
 376                 char local_buffer[1024];
 377                 local_buffer[0] = '$';
 378                 if ((size_t)len + 4 <= sizeof(local_buffer)) {
 379                         /* performance gain on smaller packets by only a single call to gdb_write() */
 380                         memcpy(local_buffer + 1, buffer, len++);
 381                         len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum);
 382                         retval = gdb_write(connection, local_buffer, len);
 383                         if (retval != ERROR_OK)
 384                                 return retval;
 385                 } else {
 386                         /* larger packets are transmitted directly from caller supplied buffer
 387                          * by several calls to gdb_write() to avoid dynamic allocation */
 388                         snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum);
 389                         retval = gdb_write(connection, local_buffer, 1);
 390                         if (retval != ERROR_OK)
 391                                 return retval;
 392                         retval = gdb_write(connection, buffer, len);
 393                         if (retval != ERROR_OK)
 394                                 return retval;
 395                         retval = gdb_write(connection, local_buffer + 1, 3);
 396                         if (retval != ERROR_OK)
 397                                 return retval;
 398                 }
 399
 400                 if (gdb_con->noack_mode)
 401                         break;
 402
 403                 retval = gdb_get_char(connection, &reply);
 404                 if (retval != ERROR_OK)
 405                         return retval;
 406
 407                 if (reply == '+')
 408                         break;
 409                 else if (reply == '-') {
 410                         /* Stop sending output packets for now */
 411                         log_remove_callback(gdb_log_callback, connection);
 412                         LOG_WARNING("negative reply, retrying");
 413                 } else if (reply == 0x3) {
 414                         gdb_con->ctrl_c = 1;
 415                         retval = gdb_get_char(connection, &reply);
 416                         if (retval != ERROR_OK)
 417                                 return retval;
 418                         if (reply == '+')
 419                                 break;
 420                         else if (reply == '-') {
 421                                 /* Stop sending output packets for now */
 422                                 log_remove_callback(gdb_log_callback, connection);
 423                                 LOG_WARNING("negative reply, retrying");
 424                         } else if (reply == '$') {
 425                                 LOG_ERROR("GDB missing ack(1) - assumed good");
 426                                 gdb_putback_char(connection, reply);
 427                                 return ERROR_OK;
 428                         } else {
 429                                 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
 430                                 gdb_con->closed = 1;
 431                                 return ERROR_SERVER_REMOTE_CLOSED;
 432                         }
 433                 } else if (reply == '$') {
 434                         LOG_ERROR("GDB missing ack(2) - assumed good");
 435                         gdb_putback_char(connection, reply);
 436                         return ERROR_OK;
 437                 } else {
 438                         LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
 439                                 reply);
 440                         gdb_con->closed = 1;
 441                         return ERROR_SERVER_REMOTE_CLOSED;
 442                 }
 443         }
 444         if (gdb_con->closed)
 445                 return ERROR_SERVER_REMOTE_CLOSED;
 446
 447         return ERROR_OK;
 448 }
 449
 450 int gdb_put_packet(struct connection *connection, char *buffer, int len)
 451 {
 452         struct gdb_connection *gdb_con = connection->priv;
 453         gdb_con->busy = 1;
 454         int retval = gdb_put_packet_inner(connection, buffer, len);
 455         gdb_con->busy = 0;
 456
 457         /* we sent some data, reset timer for keep alive messages */
 458         kept_alive();
 459
 460         return retval;
 461 }
 462
 463 static inline int fetch_packet(struct connection *connection,
 464                 int *checksum_ok, int noack, int *len, char *buffer)
 465 {
 466         unsigned char my_checksum = 0;
 467         char checksum[3];
 468         int character;
 469         int retval = ERROR_OK;
 470
 471         struct gdb_connection *gdb_con = connection->priv;
 472         my_checksum = 0;
 473         int count = 0;
 474         count = 0;
 475
 476         /* move this over into local variables to use registers and give the
 477          * more freedom to optimize */
 478         char *buf_p = gdb_con->buf_p;
 479         int buf_cnt = gdb_con->buf_cnt;
 480
 481         for (;; ) {
 482                 /* The common case is that we have an entire packet with no escape chars.
 483                  * We need to leave at least 2 bytes in the buffer to have
 484                  * gdb_get_char() update various bits and bobs correctly.
 485                  */
 486                 if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) {
 487                         /* The compiler will struggle a bit with constant propagation and
 488                          * aliasing, so we help it by showing that these values do not
 489                          * change inside the loop
 490                          */
 491                         int i;
 492                         char *buf = buf_p;
 493                         int run = buf_cnt - 2;
 494                         i = 0;
 495                         int done = 0;
 496                         while (i < run) {
 497                                 character = *buf++;
 498                                 i++;
 499                                 if (character == '#') {
 500                                         /* Danger! character can be '#' when esc is
 501                                          * used so we need an explicit boolean for done here. */
 502                                         done = 1;
 503                                         break;
 504                                 }
 505
 506                                 if (character == '}') {
 507                                         /* data transmitted in binary mode (X packet)
 508                                          * uses 0x7d as escape character */
 509                                         my_checksum += character & 0xff;
 510                                         character = *buf++;
 511                                         i++;
 512                                         my_checksum += character & 0xff;
 513                                         buffer[count++] = (character ^ 0x20) & 0xff;
 514                                 } else {
 515                                         my_checksum += character & 0xff;
 516                                         buffer[count++] = character & 0xff;
 517                                 }
 518                         }
 519                         buf_p += i;
 520                         buf_cnt -= i;
 521                         if (done)
 522                                 break;
 523                 }
 524                 if (count > *len) {
 525                         LOG_ERROR("packet buffer too small");
 526                         retval = ERROR_GDB_BUFFER_TOO_SMALL;
 527                         break;
 528                 }
 529
 530                 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 531                 if (retval != ERROR_OK)
 532                         break;
 533
 534                 if (character == '#')
 535                         break;
 536
 537                 if (character == '}') {
 538                         /* data transmitted in binary mode (X packet)
 539                          * uses 0x7d as escape character */
 540                         my_checksum += character & 0xff;
 541
 542                         retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 543                         if (retval != ERROR_OK)
 544                                 break;
 545
 546                         my_checksum += character & 0xff;
 547                         buffer[count++] = (character ^ 0x20) & 0xff;
 548                 } else {
 549                         my_checksum += character & 0xff;
 550                         buffer[count++] = character & 0xff;
 551                 }
 552         }
 553
 554         gdb_con->buf_p = buf_p;
 555         gdb_con->buf_cnt = buf_cnt;
 556
 557         if (retval != ERROR_OK)
 558                 return retval;
 559
 560         *len = count;
 561
 562         retval = gdb_get_char(connection, &character);
 563         if (retval != ERROR_OK)
 564                 return retval;
 565         checksum[0] = character;
 566         retval = gdb_get_char(connection, &character);
 567         if (retval != ERROR_OK)
 568                 return retval;
 569         checksum[1] = character;
 570         checksum[2] = 0;
 571
 572         if (!noack)
 573                 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
 574
 575         return ERROR_OK;
 576 }
 577
 578 static int gdb_get_packet_inner(struct connection *connection,
 579                 char *buffer, int *len)
 580 {
 581         int character;
 582         int retval;
 583         struct gdb_connection *gdb_con = connection->priv;
 584
 585         while (1) {
 586                 do {
 587                         retval = gdb_get_char(connection, &character);
 588                         if (retval != ERROR_OK)
 589                                 return retval;
 590
 591 #ifdef _DEBUG_GDB_IO_
 592                         LOG_DEBUG("character: '%c'", character);
 593 #endif
 594
 595                         switch (character) {
 596                                 case '$':
 597                                         break;
 598                                 case '+':
 599                                         /* gdb sends a dummy ack '+' at every remote connect - see
 600                                          * remote_start_remote (remote.c)
 601                                          * in case anyone tries to debug why they receive this
 602                                          * warning every time */
 603                                         LOG_WARNING("acknowledgment received, but no packet pending");
 604                                         break;
 605                                 case '-':
 606                                         LOG_WARNING("negative acknowledgment, but no packet pending");
 607                                         break;
 608                                 case 0x3:
 609                                         gdb_con->ctrl_c = 1;
 610                                         *len = 0;
 611                                         return ERROR_OK;
 612                                 default:
 613                                         LOG_WARNING("ignoring character 0x%x", character);
 614                                         break;
 615                         }
 616                 } while (character != '$');
 617
 618                 int checksum_ok = 0;
 619                 /* explicit code expansion here to get faster inlined code in -O3 by not
 620                  * calculating checksum */
 621                 if (gdb_con->noack_mode) {
 622                         retval = fetch_packet(connection, &checksum_ok, 1, len, buffer);
 623                         if (retval != ERROR_OK)
 624                                 return retval;
 625                 } else {
 626                         retval = fetch_packet(connection, &checksum_ok, 0, len, buffer);
 627                         if (retval != ERROR_OK)
 628                                 return retval;
 629                 }
 630
 631                 if (gdb_con->noack_mode) {
 632                         /* checksum is not checked in noack mode */
 633                         break;
 634                 }
 635                 if (checksum_ok) {
 636                         retval = gdb_write(connection, "+", 1);
 637                         if (retval != ERROR_OK)
 638                                 return retval;
 639                         break;
 640                 }
 641         }
 642         if (gdb_con->closed)
 643                 return ERROR_SERVER_REMOTE_CLOSED;
 644
 645         return ERROR_OK;
 646 }
 647
 648 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
 649 {
 650         struct gdb_connection *gdb_con = connection->priv;
 651         gdb_con->busy = 1;
 652         int retval = gdb_get_packet_inner(connection, buffer, len);
 653         gdb_con->busy = 0;
 654         return retval;
 655 }
 656
 657 static int gdb_output_con(struct connection *connection, const char *line)
 658 {
 659         char *hex_buffer;
 660         int bin_size;
 661
 662         bin_size = strlen(line);
 663
 664         hex_buffer = malloc(bin_size * 2 + 2);
 665         if (hex_buffer == NULL)
 666                 return ERROR_GDB_BUFFER_TOO_SMALL;
 667
 668         hex_buffer[0] = 'O';
 669         int pkt_len = hexify(hex_buffer + 1, line, bin_size, bin_size * 2 + 1);
 670         int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1);
 671
 672         free(hex_buffer);
 673         return retval;
 674 }
 675
 676 static int gdb_output(struct command_context *context, const char *line)
 677 {
 678         /* this will be dumped to the log and also sent as an O packet if possible */
 679         LOG_USER_N("%s", line);
 680         return ERROR_OK;
 681 }
 682
 683 static void gdb_frontend_halted(struct target *target, struct connection *connection)
 684 {
 685         struct gdb_connection *gdb_connection = connection->priv;
 686
 687         /* In the GDB protocol when we are stepping or continuing execution,
 688          * we have a lingering reply. Upon receiving a halted event
 689          * when we have that lingering packet, we reply to the original
 690          * step or continue packet.
 691          *
 692          * Executing monitor commands can bring the target in and
 693          * out of the running state so we'll see lots of TARGET_EVENT_XXX
 694          * that are to be ignored.
 695          */
 696         if (gdb_connection->frontend_state == TARGET_RUNNING) {
 697                 char sig_reply[4];
 698                 int signal_var;
 699
 700                 /* stop forwarding log packets! */
 701                 log_remove_callback(gdb_log_callback, connection);
 702
 703                 if (gdb_connection->ctrl_c) {
 704                         signal_var = 0x2;
 705                         gdb_connection->ctrl_c = 0;
 706                 } else
 707                         signal_var = gdb_last_signal(target);
 708
 709                 snprintf(sig_reply, 4, "T%2.2x", signal_var);
 710                 gdb_put_packet(connection, sig_reply, 3);
 711                 gdb_connection->frontend_state = TARGET_HALTED;
 712                 rtos_update_threads(target);
 713         }
 714 }
 715
 716 static int gdb_target_callback_event_handler(struct target *target,
 717                 enum target_event event, void *priv)
 718 {
 719         int retval;
 720         struct connection *connection = priv;
 721
 722         switch (event) {
 723                 case TARGET_EVENT_GDB_HALT:
 724                         gdb_frontend_halted(target, connection);
 725                         break;
 726                 case TARGET_EVENT_HALTED:
 727                         target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
 728                         break;
 729                 case TARGET_EVENT_GDB_FLASH_ERASE_START:
 730                         retval = jtag_execute_queue();
 731                         if (retval != ERROR_OK)
 732                                 return retval;
 733                         break;
 734                 default:
 735                         break;
 736         }
 737
 738         return ERROR_OK;
 739 }
 740
 741 static int gdb_new_connection(struct connection *connection)
 742 {
 743         struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
 744         struct gdb_service *gdb_service = connection->service->priv;
 745         int retval;
 746         int initial_ack;
 747
 748         connection->priv = gdb_connection;
 749
 750         /* initialize gdb connection information */
 751         gdb_connection->buf_p = gdb_connection->buffer;
 752         gdb_connection->buf_cnt = 0;
 753         gdb_connection->ctrl_c = 0;
 754         gdb_connection->frontend_state = TARGET_HALTED;
 755         gdb_connection->vflash_image = NULL;
 756         gdb_connection->closed = 0;
 757         gdb_connection->busy = 0;
 758         gdb_connection->noack_mode = 0;
 759         gdb_connection->sync = true;
 760         gdb_connection->mem_write_error = false;
 761         gdb_connection->attached = true;
 762
 763         /* send ACK to GDB for debug request */
 764         gdb_write(connection, "+", 1);
 765
 766         /* output goes through gdb connection */
 767         command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
 768
 769         /* we must remove all breakpoints registered to the target as a previous
 770          * GDB session could leave dangling breakpoints if e.g. communication
 771          * timed out.
 772          */
 773         breakpoint_clear_target(gdb_service->target);
 774         watchpoint_clear_target(gdb_service->target);
 775
 776         /* clean previous rtos session if supported*/
 777         if ((gdb_service->target->rtos) && (gdb_service->target->rtos->type->clean))
 778                 gdb_service->target->rtos->type->clean(gdb_service->target);
 779
 780         /* remove the initial ACK from the incoming buffer */
 781         retval = gdb_get_char(connection, &initial_ack);
 782         if (retval != ERROR_OK)
 783                 return retval;
 784
 785         /* FIX!!!??? would we actually ever receive a + here???
 786          * Not observed.
 787          */
 788         if (initial_ack != '+')
 789                 gdb_putback_char(connection, initial_ack);
 790         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH);
 791
 792         if (gdb_use_memory_map) {
 793                 /* Connect must fail if the memory map can't be set up correctly.
 794                  *
 795                  * This will cause an auto_probe to be invoked, which is either
 796                  * a no-op or it will fail when the target isn't ready(e.g. not halted).
 797                  */
 798                 int i;
 799                 for (i = 0; i < flash_get_bank_count(); i++) {
 800                         struct flash_bank *p;
 801                         retval = get_flash_bank_by_num(i, &p);
 802                         if (retval != ERROR_OK) {
 803                                 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \
 804                                                 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
 805                                 return retval;
 806                         }
 807                 }
 808         }
 809
 810         gdb_actual_connections++;
 811         LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
 812                         gdb_actual_connections,
 813                         target_name(gdb_service->target),
 814                         target_state_name(gdb_service->target));
 815
 816         /* DANGER! If we fail subsequently, we must remove this handler,
 817          * otherwise we occasionally see crashes as the timer can invoke the
 818          * callback fn.
 819          *
 820          * register callback to be informed about target events */
 821         target_register_event_callback(gdb_target_callback_event_handler, connection);
 822
 823         return ERROR_OK;
 824 }
 825
 826 static int gdb_connection_closed(struct connection *connection)
 827 {
 828         struct gdb_service *gdb_service = connection->service->priv;
 829         struct gdb_connection *gdb_connection = connection->priv;
 830
 831         /* we're done forwarding messages. Tear down callback before
 832          * cleaning up connection.
 833          */
 834         log_remove_callback(gdb_log_callback, connection);
 835
 836         gdb_actual_connections--;
 837         LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
 838                 target_name(gdb_service->target),
 839                 target_state_name(gdb_service->target),
 840                 gdb_actual_connections);
 841
 842         /* see if an image built with vFlash commands is left */
 843         if (gdb_connection->vflash_image) {
 844                 image_close(gdb_connection->vflash_image);
 845                 free(gdb_connection->vflash_image);
 846                 gdb_connection->vflash_image = NULL;
 847         }
 848
 849         /* if this connection registered a debug-message receiver delete it */
 850         delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target);
 851
 852         if (connection->priv) {
 853                 free(connection->priv);
 854                 connection->priv = NULL;
 855         } else
 856                 LOG_ERROR("BUG: connection->priv == NULL");
 857
 858         target_unregister_event_callback(gdb_target_callback_event_handler, connection);
 859
 860         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_END);
 861
 862         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
 863
 864         return ERROR_OK;
 865 }
 866
 867 static void gdb_send_error(struct connection *connection, uint8_t the_error)
 868 {
 869         char err[4];
 870         snprintf(err, 4, "E%2.2X", the_error);
 871         gdb_put_packet(connection, err, 3);
 872 }
 873
 874 static int gdb_last_signal_packet(struct connection *connection,
 875                 char *packet, int packet_size)
 876 {
 877         struct target *target = get_target_from_connection(connection);
 878         struct gdb_connection *gdb_con = connection->priv;
 879         char sig_reply[4];
 880         int signal_var;
 881
 882         if (!gdb_con->attached) {
 883                 /* if we are here we have received a kill packet
 884                  * reply W stop reply otherwise gdb gets very unhappy */
 885                 gdb_put_packet(connection, "W00", 3);
 886                 return ERROR_OK;
 887         }
 888
 889         signal_var = gdb_last_signal(target);
 890
 891         snprintf(sig_reply, 4, "S%2.2x", signal_var);
 892         gdb_put_packet(connection, sig_reply, 3);
 893
 894         return ERROR_OK;
 895 }
 896
 897 static inline int gdb_reg_pos(struct target *target, int pos, int len)
 898 {
 899         if (target->endianness == TARGET_LITTLE_ENDIAN)
 900                 return pos;
 901         else
 902                 return len - 1 - pos;
 903 }
 904
 905 /* Convert register to string of bytes. NB! The # of bits in the
 906  * register might be non-divisible by 8(a byte), in which
 907  * case an entire byte is shown.
 908  *
 909  * NB! the format on the wire is the target endianness
 910  *
 911  * The format of reg->value is little endian
 912  *
 913  */
 914 static void gdb_str_to_target(struct target *target,
 915                 char *tstr, struct reg *reg)
 916 {
 917         int i;
 918
 919         uint8_t *buf;
 920         int buf_len;
 921         buf = reg->value;
 922         buf_len = DIV_ROUND_UP(reg->size, 8);
 923
 924         for (i = 0; i < buf_len; i++) {
 925                 int j = gdb_reg_pos(target, i, buf_len);
 926                 tstr += sprintf(tstr, "%02x", buf[j]);
 927         }
 928 }
 929
 930 /* copy over in register buffer */
 931 static void gdb_target_to_reg(struct target *target,
 932                 char *tstr, int str_len, uint8_t *bin)
 933 {
 934         if (str_len % 2) {
 935                 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
 936                 exit(-1);
 937         }
 938
 939         int i;
 940         for (i = 0; i < str_len; i += 2) {
 941                 unsigned t;
 942                 if (sscanf(tstr + i, "%02x", &t) != 1) {
 943                         LOG_ERROR("BUG: unable to convert register value");
 944                         exit(-1);
 945                 }
 946
 947                 int j = gdb_reg_pos(target, i/2, str_len/2);
 948                 bin[j] = t;
 949         }
 950 }
 951
 952 static int gdb_get_registers_packet(struct connection *connection,
 953                 char *packet, int packet_size)
 954 {
 955         struct target *target = get_target_from_connection(connection);
 956         struct reg **reg_list;
 957         int reg_list_size;
 958         int retval;
 959         int reg_packet_size = 0;
 960         char *reg_packet;
 961         char *reg_packet_p;
 962         int i;
 963
 964 #ifdef _DEBUG_GDB_IO_
 965         LOG_DEBUG("-");
 966 #endif
 967
 968         if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg_list(connection)))
 969                 return ERROR_OK;
 970
 971         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size);
 972         if (retval != ERROR_OK)
 973                 return gdb_error(connection, retval);
 974
 975         for (i = 0; i < reg_list_size; i++)
 976                 reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
 977
 978         assert(reg_packet_size > 0);
 979
 980         reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */
 981         reg_packet_p = reg_packet;
 982
 983         for (i = 0; i < reg_list_size; i++) {
 984                 if (!reg_list[i]->valid)
 985                         reg_list[i]->type->get(reg_list[i]);
 986                 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
 987                 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
 988         }
 989
 990 #ifdef _DEBUG_GDB_IO_
 991         {
 992                 char *reg_packet_p_debug;
 993                 reg_packet_p_debug = strndup(reg_packet, reg_packet_size);
 994                 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug);
 995                 free(reg_packet_p_debug);
 996         }
 997 #endif
 998
 999         gdb_put_packet(connection, reg_packet, reg_packet_size);
1000         free(reg_packet);
1001
1002         free(reg_list);
1003
1004         return ERROR_OK;
1005 }
1006
1007 static int gdb_set_registers_packet(struct connection *connection,
1008                 char *packet, int packet_size)
1009 {
1010         struct target *target = get_target_from_connection(connection);
1011         int i;
1012         struct reg **reg_list;
1013         int reg_list_size;
1014         int retval;
1015         char *packet_p;
1016
1017 #ifdef _DEBUG_GDB_IO_
1018         LOG_DEBUG("-");
1019 #endif
1020
1021         /* skip command character */
1022         packet++;
1023         packet_size--;
1024
1025         if (packet_size % 2) {
1026                 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1027                 return ERROR_SERVER_REMOTE_CLOSED;
1028         }
1029
1030         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size);
1031         if (retval != ERROR_OK)
1032                 return gdb_error(connection, retval);
1033
1034         packet_p = packet;
1035         for (i = 0; i < reg_list_size; i++) {
1036                 uint8_t *bin_buf;
1037                 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1038
1039                 if (packet_p + chars > packet + packet_size)
1040                         LOG_ERROR("BUG: register packet is too small for registers");
1041
1042                 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1043                 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1044
1045                 reg_list[i]->type->set(reg_list[i], bin_buf);
1046
1047                 /* advance packet pointer */
1048                 packet_p += chars;
1049
1050                 free(bin_buf);
1051         }
1052
1053         /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1054         free(reg_list);
1055
1056         gdb_put_packet(connection, "OK", 2);
1057
1058         return ERROR_OK;
1059 }
1060
1061 static int gdb_get_register_packet(struct connection *connection,
1062         char *packet, int packet_size)
1063 {
1064         struct target *target = get_target_from_connection(connection);
1065         char *reg_packet;
1066         int reg_num = strtoul(packet + 1, NULL, 16);
1067         struct reg **reg_list;
1068         int reg_list_size;
1069         int retval;
1070
1071 #ifdef _DEBUG_GDB_IO_
1072         LOG_DEBUG("-");
1073 #endif
1074
1075         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size);
1076         if (retval != ERROR_OK)
1077                 return gdb_error(connection, retval);
1078
1079         if (reg_list_size <= reg_num) {
1080                 LOG_ERROR("gdb requested a non-existing register");
1081                 return ERROR_SERVER_REMOTE_CLOSED;
1082         }
1083
1084         if (!reg_list[reg_num]->valid)
1085                 reg_list[reg_num]->type->get(reg_list[reg_num]);
1086
1087         reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1); /* plus one for string termination null */
1088
1089         gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1090
1091         gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1092
1093         free(reg_list);
1094         free(reg_packet);
1095
1096         return ERROR_OK;
1097 }
1098
1099 static int gdb_set_register_packet(struct connection *connection,
1100         char *packet, int packet_size)
1101 {
1102         struct target *target = get_target_from_connection(connection);
1103         char *separator;
1104         uint8_t *bin_buf;
1105         int reg_num = strtoul(packet + 1, &separator, 16);
1106         struct reg **reg_list;
1107         int reg_list_size;
1108         int retval;
1109
1110         LOG_DEBUG("-");
1111
1112         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size);
1113         if (retval != ERROR_OK)
1114                 return gdb_error(connection, retval);
1115
1116         if (reg_list_size <= reg_num) {
1117                 LOG_ERROR("gdb requested a non-existing register");
1118                 return ERROR_SERVER_REMOTE_CLOSED;
1119         }
1120
1121         if (*separator != '=') {
1122                 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1123                 return ERROR_SERVER_REMOTE_CLOSED;
1124         }
1125
1126         /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1127         bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
1128         int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1129
1130         if ((unsigned int)chars != strlen(separator + 1)) {
1131                 LOG_ERROR("gdb sent a packet with wrong register size");
1132                 free(bin_buf);
1133                 return ERROR_SERVER_REMOTE_CLOSED;
1134         }
1135
1136         gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1137
1138         reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1139
1140         gdb_put_packet(connection, "OK", 2);
1141
1142         free(bin_buf);
1143         free(reg_list);
1144
1145         return ERROR_OK;
1146 }
1147
1148 /* No attempt is made to translate the "retval" to
1149  * GDB speak. This has to be done at the calling
1150  * site as no mapping really exists.
1151  */
1152 static int gdb_error(struct connection *connection, int retval)
1153 {
1154         LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1155         gdb_send_error(connection, EFAULT);
1156         return ERROR_OK;
1157 }
1158
1159 /* We don't have to worry about the default 2 second timeout for GDB packets,
1160  * because GDB breaks up large memory reads into smaller reads.
1161  *
1162  * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1163  */
1164 static int gdb_read_memory_packet(struct connection *connection,
1165                 char *packet, int packet_size)
1166 {
1167         struct target *target = get_target_from_connection(connection);
1168         char *separator;
1169         uint32_t addr = 0;
1170         uint32_t len = 0;
1171
1172         uint8_t *buffer;
1173         char *hex_buffer;
1174
1175         int retval = ERROR_OK;
1176
1177         /* skip command character */
1178         packet++;
1179
1180         addr = strtoul(packet, &separator, 16);
1181
1182         if (*separator != ',') {
1183                 LOG_ERROR("incomplete read memory packet received, dropping connection");
1184                 return ERROR_SERVER_REMOTE_CLOSED;
1185         }
1186
1187         len = strtoul(separator + 1, NULL, 16);
1188
1189         buffer = malloc(len);
1190
1191         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1192
1193         retval = target_read_buffer(target, addr, len, buffer);
1194
1195         if ((retval != ERROR_OK) && !gdb_report_data_abort) {
1196                 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1197                  * At some point this might be fixed in GDB, in which case this code can be removed.
1198                  *
1199                  * OpenOCD developers are acutely aware of this problem, but there is nothing
1200                  * gained by involving the user in this problem that hopefully will get resolved
1201                  * eventually
1202                  *
1203                  * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1204                  * cmd = view%20audit-trail&database = gdb&pr = 2395
1205                  *
1206                  * For now, the default is to fix up things to make current GDB versions work.
1207                  * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1208                  */
1209                 memset(buffer, 0, len);
1210                 retval = ERROR_OK;
1211         }
1212
1213         if (retval == ERROR_OK) {
1214                 hex_buffer = malloc(len * 2 + 1);
1215
1216                 int pkt_len = hexify(hex_buffer, (char *)buffer, len, len * 2 + 1);
1217
1218                 gdb_put_packet(connection, hex_buffer, pkt_len);
1219
1220                 free(hex_buffer);
1221         } else
1222                 retval = gdb_error(connection, retval);
1223
1224         free(buffer);
1225
1226         return retval;
1227 }
1228
1229 static int gdb_write_memory_packet(struct connection *connection,
1230                 char *packet, int packet_size)
1231 {
1232         struct target *target = get_target_from_connection(connection);
1233         char *separator;
1234         uint32_t addr = 0;
1235         uint32_t len = 0;
1236
1237         uint8_t *buffer;
1238         int retval;
1239
1240         /* skip command character */
1241         packet++;
1242
1243         addr = strtoul(packet, &separator, 16);
1244
1245         if (*separator != ',') {
1246                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1247                 return ERROR_SERVER_REMOTE_CLOSED;
1248         }
1249
1250         len = strtoul(separator + 1, &separator, 16);
1251
1252         if (*(separator++) != ':') {
1253                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1254                 return ERROR_SERVER_REMOTE_CLOSED;
1255         }
1256
1257         buffer = malloc(len);
1258
1259         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1260
1261         if (unhexify((char *)buffer, separator, len) != (int)len)
1262                 LOG_ERROR("unable to decode memory packet");
1263
1264         retval = target_write_buffer(target, addr, len, buffer);
1265
1266         if (retval == ERROR_OK)
1267                 gdb_put_packet(connection, "OK", 2);
1268         else
1269                 retval = gdb_error(connection, retval);
1270
1271         free(buffer);
1272
1273         return retval;
1274 }
1275
1276 static int gdb_write_memory_binary_packet(struct connection *connection,
1277                 char *packet, int packet_size)
1278 {
1279         struct target *target = get_target_from_connection(connection);
1280         char *separator;
1281         uint32_t addr = 0;
1282         uint32_t len = 0;
1283
1284         int retval = ERROR_OK;
1285
1286         /* skip command character */
1287         packet++;
1288
1289         addr = strtoul(packet, &separator, 16);
1290
1291         if (*separator != ',') {
1292                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1293                 return ERROR_SERVER_REMOTE_CLOSED;
1294         }
1295
1296         len = strtoul(separator + 1, &separator, 16);
1297
1298         if (*(separator++) != ':') {
1299                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1300                 return ERROR_SERVER_REMOTE_CLOSED;
1301         }
1302
1303         struct gdb_connection *gdb_connection = connection->priv;
1304
1305         if (gdb_connection->mem_write_error) {
1306                 retval = ERROR_FAIL;
1307                 /* now that we have reported the memory write error, we can clear the condition */
1308                 gdb_connection->mem_write_error = false;
1309         }
1310
1311         /* By replying the packet *immediately* GDB will send us a new packet
1312          * while we write the last one to the target.
1313          */
1314         if (retval == ERROR_OK)
1315                 gdb_put_packet(connection, "OK", 2);
1316         else {
1317                 retval = gdb_error(connection, retval);
1318                 if (retval != ERROR_OK)
1319                         return retval;
1320         }
1321
1322         if (len) {
1323                 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1324
1325                 retval = target_write_buffer(target, addr, len, (uint8_t *)separator);
1326                 if (retval != ERROR_OK)
1327                         gdb_connection->mem_write_error = true;
1328         }
1329
1330         return ERROR_OK;
1331 }
1332
1333 static int gdb_step_continue_packet(struct connection *connection,
1334                 char *packet, int packet_size)
1335 {
1336         struct target *target = get_target_from_connection(connection);
1337         int current = 0;
1338         uint32_t address = 0x0;
1339         int retval = ERROR_OK;
1340
1341         LOG_DEBUG("-");
1342
1343         if (packet_size > 1) {
1344                 packet[packet_size] = 0;
1345                 address = strtoul(packet + 1, NULL, 16);
1346         } else
1347                 current = 1;
1348
1349         if (packet[0] == 'c') {
1350                 LOG_DEBUG("continue");
1351                 /* resume at current address, don't handle breakpoints, not debugging */
1352                 retval = target_resume(target, current, address, 0, 0);
1353         } else if (packet[0] == 's') {
1354                 LOG_DEBUG("step");
1355                 /* step at current or address, don't handle breakpoints */
1356                 retval = target_step(target, current, address, 0);
1357         }
1358         return retval;
1359 }
1360
1361 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1362                 char *packet, int packet_size)
1363 {
1364         struct target *target = get_target_from_connection(connection);
1365         int type;
1366         enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1367         enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1368         uint32_t address;
1369         uint32_t size;
1370         char *separator;
1371         int retval;
1372
1373         LOG_DEBUG("-");
1374
1375         type = strtoul(packet + 1, &separator, 16);
1376
1377         if (type == 0)  /* memory breakpoint */
1378                 bp_type = BKPT_SOFT;
1379         else if (type == 1)     /* hardware breakpoint */
1380                 bp_type = BKPT_HARD;
1381         else if (type == 2)     /* write watchpoint */
1382                 wp_type = WPT_WRITE;
1383         else if (type == 3)     /* read watchpoint */
1384                 wp_type = WPT_READ;
1385         else if (type == 4)     /* access watchpoint */
1386                 wp_type = WPT_ACCESS;
1387         else {
1388                 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1389                 return ERROR_SERVER_REMOTE_CLOSED;
1390         }
1391
1392         if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD)))
1393                 bp_type = gdb_breakpoint_override_type;
1394
1395         if (*separator != ',') {
1396                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1397                 return ERROR_SERVER_REMOTE_CLOSED;
1398         }
1399
1400         address = strtoul(separator + 1, &separator, 16);
1401
1402         if (*separator != ',') {
1403                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1404                 return ERROR_SERVER_REMOTE_CLOSED;
1405         }
1406
1407         size = strtoul(separator + 1, &separator, 16);
1408
1409         switch (type) {
1410                 case 0:
1411                 case 1:
1412                         if (packet[0] == 'Z') {
1413                                 retval = breakpoint_add(target, address, size, bp_type);
1414                                 if (retval != ERROR_OK) {
1415                                         retval = gdb_error(connection, retval);
1416                                         if (retval != ERROR_OK)
1417                                                 return retval;
1418                                 } else
1419                                         gdb_put_packet(connection, "OK", 2);
1420                         } else {
1421                                 breakpoint_remove(target, address);
1422                                 gdb_put_packet(connection, "OK", 2);
1423                         }
1424                         break;
1425                 case 2:
1426                 case 3:
1427                 case 4:
1428                 {
1429                         if (packet[0] == 'Z') {
1430                                 retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu);
1431                                 if (retval != ERROR_OK) {
1432                                         retval = gdb_error(connection, retval);
1433                                         if (retval != ERROR_OK)
1434                                                 return retval;
1435                                 } else
1436                                         gdb_put_packet(connection, "OK", 2);
1437                         } else {
1438                                 watchpoint_remove(target, address);
1439                                 gdb_put_packet(connection, "OK", 2);
1440                         }
1441                         break;
1442                 }
1443                 default:
1444                         break;
1445         }
1446
1447         return ERROR_OK;
1448 }
1449
1450 /* print out a string and allocate more space as needed,
1451  * mainly used for XML at this point
1452  */
1453 static void xml_printf(int *retval, char **xml, int *pos, int *size,
1454                 const char *fmt, ...)
1455 {
1456         if (*retval != ERROR_OK)
1457                 return;
1458         int first = 1;
1459
1460         for (;; ) {
1461                 if ((*xml == NULL) || (!first)) {
1462                         /* start by 0 to exercise all the code paths.
1463                          * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1464
1465                         *size = *size * 2 + 2;
1466                         char *t = *xml;
1467                         *xml = realloc(*xml, *size);
1468                         if (*xml == NULL) {
1469                                 if (t)
1470                                         free(t);
1471                                 *retval = ERROR_SERVER_REMOTE_CLOSED;
1472                                 return;
1473                         }
1474                 }
1475
1476                 va_list ap;
1477                 int ret;
1478                 va_start(ap, fmt);
1479                 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1480                 va_end(ap);
1481                 if ((ret > 0) && ((ret + 1) < *size - *pos)) {
1482                         *pos += ret;
1483                         return;
1484                 }
1485                 /* there was just enough or not enough space, allocate more. */
1486                 first = 0;
1487         }
1488 }
1489
1490 static int decode_xfer_read(char *buf, char **annex, int *ofs, unsigned int *len)
1491 {
1492         char *separator;
1493
1494         /* Extract and NUL-terminate the annex. */
1495         *annex = buf;
1496         while (*buf && *buf != ':')
1497                 buf++;
1498         if (*buf == '\0')
1499                 return -1;
1500         *buf++ = 0;
1501
1502         /* After the read marker and annex, qXfer looks like a
1503          * traditional 'm' packet. */
1504
1505         *ofs = strtoul(buf, &separator, 16);
1506
1507         if (*separator != ',')
1508                 return -1;
1509
1510         *len = strtoul(separator + 1, NULL, 16);
1511
1512         return 0;
1513 }
1514
1515 static int compare_bank(const void *a, const void *b)
1516 {
1517         struct flash_bank *b1, *b2;
1518         b1 = *((struct flash_bank **)a);
1519         b2 = *((struct flash_bank **)b);
1520
1521         if (b1->base == b2->base)
1522                 return 0;
1523         else if (b1->base > b2->base)
1524                 return 1;
1525         else
1526                 return -1;
1527 }
1528
1529 static int gdb_memory_map(struct connection *connection,
1530                 char *packet, int packet_size)
1531 {
1532         /* We get away with only specifying flash here. Regions that are not
1533          * specified are treated as if we provided no memory map(if not we
1534          * could detect the holes and mark them as RAM).
1535          * Normally we only execute this code once, but no big deal if we
1536          * have to regenerate it a couple of times.
1537          */
1538
1539         struct target *target = get_target_from_connection(connection);
1540         struct flash_bank *p;
1541         char *xml = NULL;
1542         int size = 0;
1543         int pos = 0;
1544         int retval = ERROR_OK;
1545         struct flash_bank **banks;
1546         int offset;
1547         int length;
1548         char *separator;
1549         uint32_t ram_start = 0;
1550         int i;
1551         int target_flash_banks = 0;
1552
1553         /* skip command character */
1554         packet += 23;
1555
1556         offset = strtoul(packet, &separator, 16);
1557         length = strtoul(separator + 1, &separator, 16);
1558
1559         xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1560
1561         /* Sort banks in ascending order.  We need to report non-flash
1562          * memory as ram (or rather read/write) by default for GDB, since
1563          * it has no concept of non-cacheable read/write memory (i/o etc).
1564          *
1565          * FIXME Most non-flash addresses are *NOT* RAM!  Don't lie.
1566          * Current versions of GDB assume unlisted addresses are RAM...
1567          */
1568         banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1569
1570         for (i = 0; i < flash_get_bank_count(); i++) {
1571                 retval = get_flash_bank_by_num(i, &p);
1572                 if (retval != ERROR_OK) {
1573                         free(banks);
1574                         gdb_error(connection, retval);
1575                         return retval;
1576                 }
1577                 if (p->target == target)
1578                         banks[target_flash_banks++] = p;
1579         }
1580
1581         qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1582                 compare_bank);
1583
1584         for (i = 0; i < target_flash_banks; i++) {
1585                 int j;
1586                 unsigned sector_size = 0;
1587                 uint32_t start;
1588
1589                 p = banks[i];
1590                 start = p->base;
1591
1592                 if (ram_start < p->base)
1593                         xml_printf(&retval, &xml, &pos, &size,
1594                                 "<memory type=\"ram\" start=\"0x%x\" "
1595                                 "length=\"0x%x\"/>\n",
1596                                 ram_start, p->base - ram_start);
1597
1598                 /* Report adjacent groups of same-size sectors.  So for
1599                  * example top boot CFI flash will list an initial region
1600                  * with several large sectors (maybe 128KB) and several
1601                  * smaller ones at the end (maybe 32KB).  STR7 will have
1602                  * regions with 8KB, 32KB, and 64KB sectors; etc.
1603                  */
1604                 for (j = 0; j < p->num_sectors; j++) {
1605                         unsigned group_len;
1606
1607                         /* Maybe start a new group of sectors. */
1608                         if (sector_size == 0) {
1609                                 start = p->base + p->sectors[j].offset;
1610                                 xml_printf(&retval, &xml, &pos, &size,
1611                                         "<memory type=\"flash\" "
1612                                         "start=\"0x%x\" ",
1613                                         start);
1614                                 sector_size = p->sectors[j].size;
1615                         }
1616
1617                         /* Does this finish a group of sectors?
1618                          * If not, continue an already-started group.
1619                          */
1620                         if (j == p->num_sectors - 1)
1621                                 group_len = (p->base + p->size) - start;
1622                         else if (p->sectors[j + 1].size != sector_size)
1623                                 group_len = p->base + p->sectors[j + 1].offset
1624                                         - start;
1625                         else
1626                                 continue;
1627
1628                         xml_printf(&retval, &xml, &pos, &size,
1629                                 "length=\"0x%x\">\n"
1630                                 "<property name=\"blocksize\">"
1631                                 "0x%x</property>\n"
1632                                 "</memory>\n",
1633                                 group_len,
1634                                 sector_size);
1635                         sector_size = 0;
1636                 }
1637
1638                 ram_start = p->base + p->size;
1639         }
1640
1641         if (ram_start != 0)
1642                 xml_printf(&retval, &xml, &pos, &size,
1643                         "<memory type=\"ram\" start=\"0x%x\" "
1644                         "length=\"0x%x\"/>\n",
1645                         ram_start, 0-ram_start);
1646         /* ELSE a flash chip could be at the very end of the 32 bit address
1647          * space, in which case ram_start will be precisely 0
1648          */
1649
1650         free(banks);
1651         banks = NULL;
1652
1653         xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1654
1655         if (retval != ERROR_OK) {
1656                 gdb_error(connection, retval);
1657                 return retval;
1658         }
1659
1660         if (offset + length > pos)
1661                 length = pos - offset;
1662
1663         char *t = malloc(length + 1);
1664         t[0] = 'l';
1665         memcpy(t + 1, xml + offset, length);
1666         gdb_put_packet(connection, t, length + 1);
1667
1668         free(t);
1669         free(xml);
1670         return ERROR_OK;
1671 }
1672
1673 static int gdb_query_packet(struct connection *connection,
1674                 char *packet, int packet_size)
1675 {
1676         struct command_context *cmd_ctx = connection->cmd_ctx;
1677         struct gdb_connection *gdb_connection = connection->priv;
1678         struct target *target = get_target_from_connection(connection);
1679
1680         if (strncmp(packet, "qRcmd,", 6) == 0) {
1681                 if (packet_size > 6) {
1682                         char *cmd;
1683                         cmd = malloc((packet_size - 6) / 2 + 1);
1684                         int len = unhexify(cmd, packet + 6, (packet_size - 6) / 2);
1685                         cmd[len] = 0;
1686
1687                         /* We want to print all debug output to GDB connection */
1688                         log_add_callback(gdb_log_callback, connection);
1689                         target_call_timer_callbacks_now();
1690                         /* some commands need to know the GDB connection, make note of current
1691                          * GDB connection. */
1692                         current_gdb_connection = gdb_connection;
1693                         command_run_line(cmd_ctx, cmd);
1694                         current_gdb_connection = NULL;
1695                         target_call_timer_callbacks_now();
1696                         log_remove_callback(gdb_log_callback, connection);
1697                         free(cmd);
1698                 }
1699                 gdb_put_packet(connection, "OK", 2);
1700                 return ERROR_OK;
1701         } else if (strncmp(packet, "qCRC:", 5) == 0) {
1702                 if (packet_size > 5) {
1703                         int retval;
1704                         char gdb_reply[10];
1705                         char *separator;
1706                         uint32_t checksum;
1707                         uint32_t addr = 0;
1708                         uint32_t len = 0;
1709
1710                         /* skip command character */
1711                         packet += 5;
1712
1713                         addr = strtoul(packet, &separator, 16);
1714
1715                         if (*separator != ',') {
1716                                 LOG_ERROR("incomplete read memory packet received, dropping connection");
1717                                 return ERROR_SERVER_REMOTE_CLOSED;
1718                         }
1719
1720                         len = strtoul(separator + 1, NULL, 16);
1721
1722                         retval = target_checksum_memory(target, addr, len, &checksum);
1723
1724                         if (retval == ERROR_OK) {
1725                                 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
1726                                 gdb_put_packet(connection, gdb_reply, 9);
1727                         } else {
1728                                 retval = gdb_error(connection, retval);
1729                                 if (retval != ERROR_OK)
1730                                         return retval;
1731                         }
1732
1733                         return ERROR_OK;
1734                 }
1735         } else if (strncmp(packet, "qSupported", 10) == 0) {
1736                 /* we currently support packet size and qXfer:memory-map:read (if enabled)
1737                  * disable qXfer:features:read for the moment */
1738                 int retval = ERROR_OK;
1739                 char *buffer = NULL;
1740                 int pos = 0;
1741                 int size = 0;
1742
1743                 xml_printf(&retval,
1744                         &buffer,
1745                         &pos,
1746                         &size,
1747                         "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read-;QStartNoAckMode+",
1748                         (GDB_BUFFER_SIZE - 1),
1749                         ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-');
1750
1751                 if (retval != ERROR_OK) {
1752                         gdb_send_error(connection, 01);
1753                         return ERROR_OK;
1754                 }
1755
1756                 gdb_put_packet(connection, buffer, strlen(buffer));
1757                 free(buffer);
1758
1759                 return ERROR_OK;
1760         } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0)
1761                    && (flash_get_bank_count() > 0))
1762                 return gdb_memory_map(connection, packet, packet_size);
1763         else if (strncmp(packet, "qXfer:features:read:", 20) == 0) {
1764                 char *xml = NULL;
1765                 int size = 0;
1766                 int pos = 0;
1767                 int retval = ERROR_OK;
1768
1769                 int offset;
1770                 unsigned int length;
1771                 char *annex;
1772
1773                 /* skip command character */
1774                 packet += 20;
1775
1776                 if (decode_xfer_read(packet, &annex, &offset, &length) < 0) {
1777                         gdb_send_error(connection, 01);
1778                         return ERROR_OK;
1779                 }
1780
1781                 if (strcmp(annex, "target.xml") != 0) {
1782                         gdb_send_error(connection, 01);
1783                         return ERROR_OK;
1784                 }
1785
1786                 xml_printf(&retval,
1787                         &xml,
1788                         &pos,
1789                         &size, \
1790                         "l < target version=\"1.0\">\n < architecture > arm</architecture>\n</target>\n");
1791
1792                 if (retval != ERROR_OK) {
1793                         gdb_error(connection, retval);
1794                         return retval;
1795                 }
1796
1797                 gdb_put_packet(connection, xml, strlen(xml));
1798
1799                 free(xml);
1800                 return ERROR_OK;
1801         } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) {
1802                 gdb_connection->noack_mode = 1;
1803                 gdb_put_packet(connection, "OK", 2);
1804                 return ERROR_OK;
1805         }
1806
1807         gdb_put_packet(connection, "", 0);
1808         return ERROR_OK;
1809 }
1810
1811 static int gdb_v_packet(struct connection *connection,
1812                 char *packet, int packet_size)
1813 {
1814         struct gdb_connection *gdb_connection = connection->priv;
1815         struct gdb_service *gdb_service = connection->service->priv;
1816         int result;
1817
1818         /* if flash programming disabled - send a empty reply */
1819
1820         if (gdb_flash_program == 0) {
1821                 gdb_put_packet(connection, "", 0);
1822                 return ERROR_OK;
1823         }
1824
1825         if (strncmp(packet, "vFlashErase:", 12) == 0) {
1826                 unsigned long addr;
1827                 unsigned long length;
1828
1829                 char *parse = packet + 12;
1830                 if (*parse == '\0') {
1831                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1832                         return ERROR_SERVER_REMOTE_CLOSED;
1833                 }
1834
1835                 addr = strtoul(parse, &parse, 16);
1836
1837                 if (*(parse++) != ',' || *parse == '\0') {
1838                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1839                         return ERROR_SERVER_REMOTE_CLOSED;
1840                 }
1841
1842                 length = strtoul(parse, &parse, 16);
1843
1844                 if (*parse != '\0') {
1845                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1846                         return ERROR_SERVER_REMOTE_CLOSED;
1847                 }
1848
1849                 /* assume all sectors need erasing - stops any problems
1850                  * when flash_write is called multiple times */
1851                 flash_set_dirty();
1852
1853                 /* perform any target specific operations before the erase */
1854                 target_call_event_callbacks(gdb_service->target,
1855                         TARGET_EVENT_GDB_FLASH_ERASE_START);
1856
1857                 /* vFlashErase:addr,length messages require region start and
1858                  * end to be "block" aligned ... if padding is ever needed,
1859                  * GDB will have become dangerously confused.
1860                  */
1861                 result = flash_erase_address_range(gdb_service->target,
1862                                 false, addr, length);
1863
1864                 /* perform any target specific operations after the erase */
1865                 target_call_event_callbacks(gdb_service->target,
1866                         TARGET_EVENT_GDB_FLASH_ERASE_END);
1867
1868                 /* perform erase */
1869                 if (result != ERROR_OK) {
1870                         /* GDB doesn't evaluate the actual error number returned,
1871                          * treat a failed erase as an I/O error
1872                          */
1873                         gdb_send_error(connection, EIO);
1874                         LOG_ERROR("flash_erase returned %i", result);
1875                 } else
1876                         gdb_put_packet(connection, "OK", 2);
1877
1878                 return ERROR_OK;
1879         }
1880
1881         if (strncmp(packet, "vFlashWrite:", 12) == 0) {
1882                 int retval;
1883                 unsigned long addr;
1884                 unsigned long length;
1885                 char *parse = packet + 12;
1886
1887                 if (*parse == '\0') {
1888                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1889                         return ERROR_SERVER_REMOTE_CLOSED;
1890                 }
1891                 addr = strtoul(parse, &parse, 16);
1892                 if (*(parse++) != ':') {
1893                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
1894                         return ERROR_SERVER_REMOTE_CLOSED;
1895                 }
1896                 length = packet_size - (parse - packet);
1897
1898                 /* create a new image if there isn't already one */
1899                 if (gdb_connection->vflash_image == NULL) {
1900                         gdb_connection->vflash_image = malloc(sizeof(struct image));
1901                         image_open(gdb_connection->vflash_image, "", "build");
1902                 }
1903
1904                 /* create new section with content from packet buffer */
1905                 retval = image_add_section(gdb_connection->vflash_image,
1906                                 addr, length, 0x0, (uint8_t *)parse);
1907                 if (retval != ERROR_OK)
1908                         return retval;
1909
1910                 gdb_put_packet(connection, "OK", 2);
1911
1912                 return ERROR_OK;
1913         }
1914
1915         if (strncmp(packet, "vFlashDone", 10) == 0) {
1916                 uint32_t written;
1917
1918                 /* process the flashing buffer. No need to erase as GDB
1919                  * always issues a vFlashErase first. */
1920                 target_call_event_callbacks(gdb_service->target,
1921                                 TARGET_EVENT_GDB_FLASH_WRITE_START);
1922                 result = flash_write(gdb_service->target, gdb_connection->vflash_image, &written, 0);
1923                 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_END);
1924                 if (result != ERROR_OK) {
1925                         if (result == ERROR_FLASH_DST_OUT_OF_BANK)
1926                                 gdb_put_packet(connection, "E.memtype", 9);
1927                         else
1928                                 gdb_send_error(connection, EIO);
1929                 } else {
1930                         LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
1931                         gdb_put_packet(connection, "OK", 2);
1932                 }
1933
1934                 image_close(gdb_connection->vflash_image);
1935                 free(gdb_connection->vflash_image);
1936                 gdb_connection->vflash_image = NULL;
1937
1938                 return ERROR_OK;
1939         }
1940
1941         gdb_put_packet(connection, "", 0);
1942         return ERROR_OK;
1943 }
1944
1945 static int gdb_detach(struct connection *connection)
1946 {
1947         struct gdb_service *gdb_service = connection->service->priv;
1948
1949         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
1950
1951         return gdb_put_packet(connection, "OK", 2);
1952 }
1953
1954 static void gdb_log_callback(void *priv, const char *file, unsigned line,
1955                 const char *function, const char *string)
1956 {
1957         struct connection *connection = priv;
1958         struct gdb_connection *gdb_con = connection->priv;
1959
1960         if (gdb_con->busy) {
1961                 /* do not reply this using the O packet */
1962                 return;
1963         }
1964
1965         gdb_output_con(connection, string);
1966 }
1967
1968 static void gdb_sig_halted(struct connection *connection)
1969 {
1970         char sig_reply[4];
1971         snprintf(sig_reply, 4, "T%2.2x", 2);
1972         gdb_put_packet(connection, sig_reply, 3);
1973 }
1974
1975 static int gdb_input_inner(struct connection *connection)
1976 {
1977         /* Do not allocate this on the stack */
1978         static char gdb_packet_buffer[GDB_BUFFER_SIZE];
1979
1980         struct gdb_service *gdb_service = connection->service->priv;
1981         struct target *target = gdb_service->target;
1982         char *packet = gdb_packet_buffer;
1983         int packet_size;
1984         int retval;
1985         struct gdb_connection *gdb_con = connection->priv;
1986         static int extended_protocol;
1987
1988         /* drain input buffer. If one of the packets fail, then an error
1989          * packet is replied, if applicable.
1990          *
1991          * This loop will terminate and the error code is returned.
1992          *
1993          * The calling fn will check if this error is something that
1994          * can be recovered from, or if the connection must be closed.
1995          *
1996          * If the error is recoverable, this fn is called again to
1997          * drain the rest of the buffer.
1998          */
1999         do {
2000                 packet_size = GDB_BUFFER_SIZE-1;
2001                 retval = gdb_get_packet(connection, packet, &packet_size);
2002                 if (retval != ERROR_OK)
2003                         return retval;
2004
2005                 /* terminate with zero */
2006                 packet[packet_size] = 0;
2007
2008                 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
2009                         if (packet[0] == 'X') {
2010                                 /* binary packets spew junk into the debug log stream */
2011                                 char buf[50];
2012                                 int x;
2013                                 for (x = 0; (x < 49) && (packet[x] != ':'); x++)
2014                                         buf[x] = packet[x];
2015                                 buf[x] = 0;
2016                                 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
2017                         } else
2018                                 LOG_DEBUG("received packet: '%s'", packet);
2019                 }
2020
2021                 if (packet_size > 0) {
2022                         retval = ERROR_OK;
2023                         switch (packet[0]) {
2024                                 case 'T':       /* Is thread alive? */
2025                                         gdb_thread_packet(connection, packet, packet_size);
2026                                         break;
2027                                 case 'H':       /* Set current thread ( 'c' for step and continue,
2028                                                          * 'g' for all other operations ) */
2029                                         gdb_thread_packet(connection, packet, packet_size);
2030                                         break;
2031                                 case 'q':
2032                                 case 'Q':
2033                                         retval = gdb_thread_packet(connection, packet, packet_size);
2034                                         if (retval == GDB_THREAD_PACKET_NOT_CONSUMED)
2035                                                 retval = gdb_query_packet(connection, packet, packet_size);
2036                                         break;
2037                                 case 'g':
2038                                         retval = gdb_get_registers_packet(connection, packet, packet_size);
2039                                         break;
2040                                 case 'G':
2041                                         retval = gdb_set_registers_packet(connection, packet, packet_size);
2042                                         break;
2043                                 case 'p':
2044                                         retval = gdb_get_register_packet(connection, packet, packet_size);
2045                                         break;
2046                                 case 'P':
2047                                         retval = gdb_set_register_packet(connection, packet, packet_size);
2048                                         break;
2049                                 case 'm':
2050                                         retval = gdb_read_memory_packet(connection, packet, packet_size);
2051                                         break;
2052                                 case 'M':
2053                                         retval = gdb_write_memory_packet(connection, packet, packet_size);
2054                                         break;
2055                                 case 'z':
2056                                 case 'Z':
2057                                         retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size);
2058                                         break;
2059                                 case '?':
2060                                         gdb_last_signal_packet(connection, packet, packet_size);
2061                                         break;
2062                                 case 'c':
2063                                 case 's':
2064                                 {
2065                                         gdb_thread_packet(connection, packet, packet_size);
2066                                         log_add_callback(gdb_log_callback, connection);
2067
2068                                         if (gdb_con->mem_write_error) {
2069                                                 LOG_ERROR("Memory write failure!");
2070
2071                                                 /* now that we have reported the memory write error,
2072                                                  * we can clear the condition */
2073                                                 gdb_con->mem_write_error = false;
2074                                         }
2075
2076                                         bool nostep = false;
2077                                         bool already_running = false;
2078                                         if (target->state == TARGET_RUNNING) {
2079                                                 LOG_WARNING("WARNING! The target is already running. "
2080                                                                 "All changes GDB did to registers will be discarded! "
2081                                                                 "Waiting for target to halt.");
2082                                                 already_running = true;
2083                                         } else if (target->state != TARGET_HALTED) {
2084                                                 LOG_WARNING("The target is not in the halted nor running stated, " \
2085                                                                 "stepi/continue ignored.");
2086                                                 nostep = true;
2087                                         } else if ((packet[0] == 's') && gdb_con->sync) {
2088                                                 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2089                                                  * sent by GDB first to OpenOCD, thus defeating the check to
2090                                                  * make only the single stepping have the sync feature...
2091                                                  */
2092                                                 nostep = true;
2093                                                 LOG_WARNING("stepi ignored. GDB will now fetch the register state " \
2094                                                                 "from the target.");
2095                                         }
2096                                         gdb_con->sync = false;
2097
2098                                         if (!already_running && nostep) {
2099                                                 /* Either the target isn't in the halted state, then we can't
2100                                                  * step/continue. This might be early setup, etc.
2101                                                  *
2102                                                  * Or we want to allow GDB to pick up a fresh set of
2103                                                  * register values without modifying the target state.
2104                                                  *
2105                                                  */
2106                                                 gdb_sig_halted(connection);
2107
2108                                                 /* stop forwarding log packets! */
2109                                                 log_remove_callback(gdb_log_callback, connection);
2110                                         } else {
2111                                                 /* We're running/stepping, in which case we can
2112                                                  * forward log output until the target is halted
2113                                                  */
2114                                                 gdb_con->frontend_state = TARGET_RUNNING;
2115                                                 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2116
2117                                                 if (!already_running) {
2118                                                         /* Here we don't want packet processing to stop even if this fails,
2119                                                          * so we use a local variable instead of retval. */
2120                                                         retval = gdb_step_continue_packet(connection, packet, packet_size);
2121                                                         if (retval != ERROR_OK) {
2122                                                                 /* we'll never receive a halted
2123                                                                  * condition... issue a false one..
2124                                                                  */
2125                                                                 gdb_frontend_halted(target, connection);
2126                                                         }
2127                                                 }
2128                                         }
2129                                 }
2130                                 break;
2131                                 case 'v':
2132                                         retval = gdb_v_packet(connection, packet, packet_size);
2133                                         break;
2134                                 case 'D':
2135                                         retval = gdb_detach(connection);
2136                                         extended_protocol = 0;
2137                                         break;
2138                                 case 'X':
2139                                         retval = gdb_write_memory_binary_packet(connection, packet, packet_size);
2140                                         if (retval != ERROR_OK)
2141                                                 return retval;
2142                                         break;
2143                                 case 'k':
2144                                         if (extended_protocol != 0) {
2145                                                 gdb_con->attached = false;
2146                                                 break;
2147                                         }
2148                                         gdb_put_packet(connection, "OK", 2);
2149                                         return ERROR_SERVER_REMOTE_CLOSED;
2150                                 case '!':
2151                                         /* handle extended remote protocol */
2152                                         extended_protocol = 1;
2153                                         gdb_put_packet(connection, "OK", 2);
2154                                         break;
2155                                 case 'R':
2156                                         /* handle extended restart packet */
2157                                         breakpoint_clear_target(gdb_service->target);
2158                                         watchpoint_clear_target(gdb_service->target);
2159                                         command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s",
2160                                                         target_name(target));
2161                                         /* set connection as attached after reset */
2162                                         gdb_con->attached = true;
2163                                         /*  info rtos parts */
2164                                         gdb_thread_packet(connection, packet, packet_size);
2165                                         break;
2166
2167                                 case 'j':
2168                                         /* packet supported only by smp target i.e cortex_a.c*/
2169                                         /* handle smp packet replying coreid played to gbd */
2170                                         gdb_read_smp_packet(connection, packet, packet_size);
2171                                         break;
2172
2173                                 case 'J':
2174                                         /* packet supported only by smp target i.e cortex_a.c */
2175                                         /* handle smp packet setting coreid to be played at next
2176                                          * resume to gdb */
2177                                         gdb_write_smp_packet(connection, packet, packet_size);
2178                                         break;
2179
2180                                 default:
2181                                         /* ignore unknown packets */
2182                                         LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
2183                                         gdb_put_packet(connection, NULL, 0);
2184                                         break;
2185                         }
2186
2187                         /* if a packet handler returned an error, exit input loop */
2188                         if (retval != ERROR_OK)
2189                                 return retval;
2190                 }
2191
2192                 if (gdb_con->ctrl_c) {
2193                         if (target->state == TARGET_RUNNING) {
2194                                 retval = target_halt(target);
2195                                 if (retval != ERROR_OK)
2196                                         target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2197                                 gdb_con->ctrl_c = 0;
2198                         } else {
2199                                 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2200                                 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2201                         }
2202                 }
2203
2204         } while (gdb_con->buf_cnt > 0);
2205
2206         return ERROR_OK;
2207 }
2208
2209 static int gdb_input(struct connection *connection)
2210 {
2211         int retval = gdb_input_inner(connection);
2212         struct gdb_connection *gdb_con = connection->priv;
2213         if (retval == ERROR_SERVER_REMOTE_CLOSED)
2214                 return retval;
2215
2216         /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2217         if (gdb_con->closed)
2218                 return ERROR_SERVER_REMOTE_CLOSED;
2219
2220         /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2221         return ERROR_OK;
2222 }
2223
2224 static int gdb_target_start(struct target *target, const char *port)
2225 {
2226         struct gdb_service *gdb_service;
2227         int ret;
2228         gdb_service = malloc(sizeof(struct gdb_service));
2229
2230         if (NULL == gdb_service)
2231                 return -ENOMEM;
2232
2233         gdb_service->target = target;
2234         gdb_service->core[0] = -1;
2235         gdb_service->core[1] = -1;
2236         target->gdb_service = gdb_service;
2237
2238         ret = add_service("gdb",
2239                         port, 1, &gdb_new_connection, &gdb_input,
2240                         &gdb_connection_closed, gdb_service);
2241         /* initialialize all targets gdb service with the same pointer */
2242         {
2243                 struct target_list *head;
2244                 struct target *curr;
2245                 head = target->head;
2246                 while (head != (struct target_list *)NULL) {
2247                         curr = head->target;
2248                         if (curr != target)
2249                                 curr->gdb_service = gdb_service;
2250                         head = head->next;
2251                 }
2252         }
2253         return ret;
2254 }
2255
2256 static int gdb_target_add_one(struct target *target)
2257 {
2258         /*  one gdb instance per smp list */
2259         if ((target->smp) && (target->gdb_service))
2260                 return ERROR_OK;
2261         int retval = gdb_target_start(target, gdb_port_next);
2262         if (retval == ERROR_OK) {
2263                 long portnumber;
2264                 /* If we can parse the port number
2265                  * then we increment the port number for the next target.
2266                  */
2267                 char *end;
2268                 portnumber = strtol(gdb_port_next, &end, 0);
2269                 if (!*end) {
2270                         if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) {
2271                                 free((void *)gdb_port_next);
2272                                 gdb_port_next = alloc_printf("%d", portnumber+1);
2273                         }
2274                 }
2275         }
2276         return retval;
2277 }
2278
2279 int gdb_target_add_all(struct target *target)
2280 {
2281         if (NULL == target) {
2282                 LOG_WARNING("gdb services need one or more targets defined");
2283                 return ERROR_OK;
2284         }
2285
2286         while (NULL != target) {
2287                 int retval = gdb_target_add_one(target);
2288                 if (ERROR_OK != retval)
2289                         return retval;
2290
2291                 target = target->next;
2292         }
2293
2294         return ERROR_OK;
2295 }
2296
2297 COMMAND_HANDLER(handle_gdb_sync_command)
2298 {
2299         if (CMD_ARGC != 0)
2300                 return ERROR_COMMAND_SYNTAX_ERROR;
2301
2302         if (current_gdb_connection == NULL) {
2303                 command_print(CMD_CTX,
2304                         "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2305                 return ERROR_FAIL;
2306         }
2307
2308         current_gdb_connection->sync = true;
2309
2310         return ERROR_OK;
2311 }
2312
2313 /* daemon configuration command gdb_port */
2314 COMMAND_HANDLER(handle_gdb_port_command)
2315 {
2316         int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
2317         if (ERROR_OK == retval) {
2318                 free((void *)gdb_port_next);
2319                 gdb_port_next = strdup(gdb_port);
2320         }
2321         return retval;
2322 }
2323
2324 COMMAND_HANDLER(handle_gdb_memory_map_command)
2325 {
2326         if (CMD_ARGC != 1)
2327                 return ERROR_COMMAND_SYNTAX_ERROR;
2328
2329         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
2330         return ERROR_OK;
2331 }
2332
2333 COMMAND_HANDLER(handle_gdb_flash_program_command)
2334 {
2335         if (CMD_ARGC != 1)
2336                 return ERROR_COMMAND_SYNTAX_ERROR;
2337
2338         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
2339         return ERROR_OK;
2340 }
2341
2342 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
2343 {
2344         if (CMD_ARGC != 1)
2345                 return ERROR_COMMAND_SYNTAX_ERROR;
2346
2347         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
2348         return ERROR_OK;
2349 }
2350
2351 /* gdb_breakpoint_override */
2352 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
2353 {
2354         if (CMD_ARGC == 0) {
2355                 /* nothing */
2356         } else if (CMD_ARGC == 1) {
2357                 gdb_breakpoint_override = 1;
2358                 if (strcmp(CMD_ARGV[0], "hard") == 0)
2359                         gdb_breakpoint_override_type = BKPT_HARD;
2360                 else if (strcmp(CMD_ARGV[0], "soft") == 0)
2361                         gdb_breakpoint_override_type = BKPT_SOFT;
2362                 else if (strcmp(CMD_ARGV[0], "disable") == 0)
2363                         gdb_breakpoint_override = 0;
2364         } else
2365                 return ERROR_COMMAND_SYNTAX_ERROR;
2366         if (gdb_breakpoint_override)
2367                 LOG_USER("force %s breakpoints",
2368                         (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft");
2369         else
2370                 LOG_USER("breakpoint type is not overridden");
2371
2372         return ERROR_OK;
2373 }
2374
2375 static const struct command_registration gdb_command_handlers[] = {
2376         {
2377                 .name = "gdb_sync",
2378                 .handler = handle_gdb_sync_command,
2379                 .mode = COMMAND_ANY,
2380                 .help = "next stepi will return immediately allowing "
2381                         "GDB to fetch register state without affecting "
2382                         "target state",
2383                 .usage = ""
2384         },
2385         {
2386                 .name = "gdb_port",
2387                 .handler = handle_gdb_port_command,
2388                 .mode = COMMAND_ANY,
2389                 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
2390                         "server listens for the next port number after the "
2391                         "base port number specified. "
2392                         "No arguments reports GDB port. \"pipe\" means listen to stdin "
2393                         "output to stdout, an integer is base port number, \"disable\" disables "
2394                         "port. Any other string is are interpreted as named pipe to listen to. "
2395                         "Output pipe is the same name as input pipe, but with 'o' appended.",
2396                 .usage = "[port_num]",
2397         },
2398         {
2399                 .name = "gdb_memory_map",
2400                 .handler = handle_gdb_memory_map_command,
2401                 .mode = COMMAND_CONFIG,
2402                 .help = "enable or disable memory map",
2403                 .usage = "('enable'|'disable')"
2404         },
2405         {
2406                 .name = "gdb_flash_program",
2407                 .handler = handle_gdb_flash_program_command,
2408                 .mode = COMMAND_CONFIG,
2409                 .help = "enable or disable flash program",
2410                 .usage = "('enable'|'disable')"
2411         },
2412         {
2413                 .name = "gdb_report_data_abort",
2414                 .handler = handle_gdb_report_data_abort_command,
2415                 .mode = COMMAND_CONFIG,
2416                 .help = "enable or disable reporting data aborts",
2417                 .usage = "('enable'|'disable')"
2418         },
2419         {
2420                 .name = "gdb_breakpoint_override",
2421                 .handler = handle_gdb_breakpoint_override_command,
2422                 .mode = COMMAND_ANY,
2423                 .help = "Display or specify type of breakpoint "
2424                         "to be used by gdb 'break' commands.",
2425                 .usage = "('hard'|'soft'|'disable')"
2426         },
2427         COMMAND_REGISTRATION_DONE
2428 };
2429
2430 int gdb_register_commands(struct command_context *cmd_ctx)
2431 {
2432         gdb_port = strdup("3333");
2433         gdb_port_next = strdup("3333");
2434         return register_commands(cmd_ctx, NULL, gdb_command_handlers);
2435 }