git.sur5r.net Git - openocd/blob - 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  *   Copyright (C) 2013 Andes Technology                                   *
  18  *   Hsiangkai Wang <hkwang@andestech.com>                                 *
  19  *                                                                         *
  20  *   Copyright (C) 2013 Franck Jullien                                     *
  21  *   elec4fun@gmail.com                                                    *
  22  *                                                                         *
  23  *   This program is free software; you can redistribute it and/or modify  *
  24  *   it under the terms of the GNU General Public License as published by  *
  25  *   the Free Software Foundation; either version 2 of the License, or     *
  26  *   (at your option) any later version.                                   *
  27  *                                                                         *
  28  *   This program is distributed in the hope that it will be useful,       *
  29  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  30  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  31  *   GNU General Public License for more details.                          *
  32  *                                                                         *
  33  *   You should have received a copy of the GNU General Public License     *
  34  *   along with this program; if not, write to the                         *
  35  *   Free Software Foundation, Inc.,                                       *
  36  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  37  ***************************************************************************/
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include <target/breakpoints.h>
  44 #include <target/target_request.h>
  45 #include <target/register.h>
  46 #include "server.h"
  47 #include <flash/nor/core.h>
  48 #include "gdb_server.h"
  49 #include <target/image.h>
  50 #include <jtag/jtag.h>
  51 #include "rtos/rtos.h"
  52 #include "target/smp.h"
  53
  54 /**
  55  * @file
  56  * GDB server implementation.
  57  *
  58  * This implements the GDB Remote Serial Protocol, over TCP connections,
  59  * giving GDB access to the JTAG or other hardware debugging facilities
  60  * found in most modern embedded processors.
  61  */
  62
  63 struct target_desc_format {
  64         char *tdesc;
  65         uint32_t tdesc_length;
  66 };
  67
  68 /* private connection data for GDB */
  69 struct gdb_connection {
  70         char buffer[GDB_BUFFER_SIZE];
  71         char *buf_p;
  72         int buf_cnt;
  73         int ctrl_c;
  74         enum target_state frontend_state;
  75         struct image *vflash_image;
  76         int closed;
  77         int busy;
  78         int noack_mode;
  79         /* set flag to true if you want the next stepi to return immediately.
  80          * allowing GDB to pick up a fresh set of register values from the target
  81          * without modifying the target state. */
  82         bool sync;
  83         /* We delay reporting memory write errors until next step/continue or memory
  84          * write. This improves performance of gdb load significantly as the GDB packet
  85          * can be replied immediately and a new GDB packet will be ready without delay
  86          * (ca. 10% or so...). */
  87         bool mem_write_error;
  88         /* with extended-remote it seems we need to better emulate attach/detach.
  89          * what this means is we reply with a W stop reply after a kill packet,
  90          * normally we reply with a S reply via gdb_last_signal_packet.
  91          * as a side note this behaviour only effects gdb > 6.8 */
  92         bool attached;
  93         /* temporarily used for target description support */
  94         struct target_desc_format target_desc;
  95 };
  96
  97 #if 0
  98 #define _DEBUG_GDB_IO_
  99 #endif
 100
 101 static struct gdb_connection *current_gdb_connection;
 102
 103 static int gdb_breakpoint_override;
 104 static enum breakpoint_type gdb_breakpoint_override_type;
 105
 106 static int gdb_error(struct connection *connection, int retval);
 107 static char *gdb_port;
 108 static char *gdb_port_next;
 109
 110 static void gdb_log_callback(void *priv, const char *file, unsigned line,
 111                 const char *function, const char *string);
 112
 113 /* number of gdb connections, mainly to suppress gdb related debugging spam
 114  * in helper/log.c when no gdb connections are actually active */
 115 int gdb_actual_connections;
 116
 117 /* set if we are sending a memory map to gdb
 118  * via qXfer:memory-map:read packet */
 119 /* enabled by default*/
 120 static int gdb_use_memory_map = 1;
 121 /* enabled by default*/
 122 static int gdb_flash_program = 1;
 123
 124 /* if set, data aborts cause an error to be reported in memory read packets
 125  * see the code in gdb_read_memory_packet() for further explanations.
 126  * Disabled by default.
 127  */
 128 static int gdb_report_data_abort;
 129
 130 /* set if we are sending target descriptions to gdb
 131  * via qXfer:features:read packet */
 132 /* enabled by default */
 133 static int gdb_use_target_description = 1;
 134
 135 /* current processing free-run type, used by file-I/O */
 136 static char gdb_running_type;
 137
 138 static int gdb_last_signal(struct target *target)
 139 {
 140         switch (target->debug_reason) {
 141                 case DBG_REASON_DBGRQ:
 142                         return 0x2;             /* SIGINT */
 143                 case DBG_REASON_BREAKPOINT:
 144                 case DBG_REASON_WATCHPOINT:
 145                 case DBG_REASON_WPTANDBKPT:
 146                         return 0x05;    /* SIGTRAP */
 147                 case DBG_REASON_SINGLESTEP:
 148                         return 0x05;    /* SIGTRAP */
 149                 case DBG_REASON_NOTHALTED:
 150                         return 0x0;             /* no signal... shouldn't happen */
 151                 default:
 152                         LOG_USER("undefined debug reason %d - target needs reset",
 153                                         target->debug_reason);
 154                         return 0x0;
 155         }
 156 }
 157
 158 static int check_pending(struct connection *connection,
 159                 int timeout_s, int *got_data)
 160 {
 161         /* a non-blocking socket will block if there is 0 bytes available on the socket,
 162          * but return with as many bytes as are available immediately
 163          */
 164         struct timeval tv;
 165         fd_set read_fds;
 166         struct gdb_connection *gdb_con = connection->priv;
 167         int t;
 168         if (got_data == NULL)
 169                 got_data = &t;
 170         *got_data = 0;
 171
 172         if (gdb_con->buf_cnt > 0) {
 173                 *got_data = 1;
 174                 return ERROR_OK;
 175         }
 176
 177         FD_ZERO(&read_fds);
 178         FD_SET(connection->fd, &read_fds);
 179
 180         tv.tv_sec = timeout_s;
 181         tv.tv_usec = 0;
 182         if (socket_select(connection->fd + 1, &read_fds, NULL, NULL, &tv) == 0) {
 183                 /* This can typically be because a "monitor" command took too long
 184                  * before printing any progress messages
 185                  */
 186                 if (timeout_s > 0)
 187                         return ERROR_GDB_TIMEOUT;
 188                 else
 189                         return ERROR_OK;
 190         }
 191         *got_data = FD_ISSET(connection->fd, &read_fds) != 0;
 192         return ERROR_OK;
 193 }
 194
 195 static int gdb_get_char_inner(struct connection *connection, int *next_char)
 196 {
 197         struct gdb_connection *gdb_con = connection->priv;
 198         int retval = ERROR_OK;
 199
 200 #ifdef _DEBUG_GDB_IO_
 201         char *debug_buffer;
 202 #endif
 203         for (;; ) {
 204                 if (connection->service->type != CONNECTION_TCP)
 205                         gdb_con->buf_cnt = read(connection->fd, gdb_con->buffer, GDB_BUFFER_SIZE);
 206                 else {
 207                         retval = check_pending(connection, 1, NULL);
 208                         if (retval != ERROR_OK)
 209                                 return retval;
 210                         gdb_con->buf_cnt = read_socket(connection->fd,
 211                                         gdb_con->buffer,
 212                                         GDB_BUFFER_SIZE);
 213                 }
 214
 215                 if (gdb_con->buf_cnt > 0)
 216                         break;
 217                 if (gdb_con->buf_cnt == 0) {
 218                         gdb_con->closed = 1;
 219                         return ERROR_SERVER_REMOTE_CLOSED;
 220                 }
 221
 222 #ifdef _WIN32
 223                 errno = WSAGetLastError();
 224
 225                 switch (errno) {
 226                         case WSAEWOULDBLOCK:
 227                                 usleep(1000);
 228                                 break;
 229                         case WSAECONNABORTED:
 230                                 gdb_con->closed = 1;
 231                                 return ERROR_SERVER_REMOTE_CLOSED;
 232                         case WSAECONNRESET:
 233                                 gdb_con->closed = 1;
 234                                 return ERROR_SERVER_REMOTE_CLOSED;
 235                         default:
 236                                 LOG_ERROR("read: %d", errno);
 237                                 exit(-1);
 238                 }
 239 #else
 240                 switch (errno) {
 241                         case EAGAIN:
 242                                 usleep(1000);
 243                                 break;
 244                         case ECONNABORTED:
 245                                 gdb_con->closed = 1;
 246                                 return ERROR_SERVER_REMOTE_CLOSED;
 247                         case ECONNRESET:
 248                                 gdb_con->closed = 1;
 249                                 return ERROR_SERVER_REMOTE_CLOSED;
 250                         default:
 251                                 LOG_ERROR("read: %s", strerror(errno));
 252                                 gdb_con->closed = 1;
 253                                 return ERROR_SERVER_REMOTE_CLOSED;
 254                 }
 255 #endif
 256         }
 257
 258 #ifdef _DEBUG_GDB_IO_
 259         debug_buffer = strndup(gdb_con->buffer, gdb_con->buf_cnt);
 260         LOG_DEBUG("received '%s'", debug_buffer);
 261         free(debug_buffer);
 262 #endif
 263
 264         gdb_con->buf_p = gdb_con->buffer;
 265         gdb_con->buf_cnt--;
 266         *next_char = *(gdb_con->buf_p++);
 267         if (gdb_con->buf_cnt > 0)
 268                 connection->input_pending = 1;
 269         else
 270                 connection->input_pending = 0;
 271 #ifdef _DEBUG_GDB_IO_
 272         LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 273 #endif
 274
 275         return retval;
 276 }
 277
 278 /**
 279  * The cool thing about this fn is that it allows buf_p and buf_cnt to be
 280  * held in registers in the inner loop.
 281  *
 282  * For small caches and embedded systems this is important!
 283  */
 284 static inline int gdb_get_char_fast(struct connection *connection,
 285                 int *next_char, char **buf_p, int *buf_cnt)
 286 {
 287         int retval = ERROR_OK;
 288
 289         if ((*buf_cnt)-- > 0) {
 290                 *next_char = **buf_p;
 291                 (*buf_p)++;
 292                 if (*buf_cnt > 0)
 293                         connection->input_pending = 1;
 294                 else
 295                         connection->input_pending = 0;
 296
 297 #ifdef _DEBUG_GDB_IO_
 298                 LOG_DEBUG("returned char '%c' (0x%2.2x)", *next_char, *next_char);
 299 #endif
 300
 301                 return ERROR_OK;
 302         }
 303
 304         struct gdb_connection *gdb_con = connection->priv;
 305         gdb_con->buf_p = *buf_p;
 306         gdb_con->buf_cnt = *buf_cnt;
 307         retval = gdb_get_char_inner(connection, next_char);
 308         *buf_p = gdb_con->buf_p;
 309         *buf_cnt = gdb_con->buf_cnt;
 310
 311         return retval;
 312 }
 313
 314 static int gdb_get_char(struct connection *connection, int *next_char)
 315 {
 316         struct gdb_connection *gdb_con = connection->priv;
 317         return gdb_get_char_fast(connection, next_char, &gdb_con->buf_p, &gdb_con->buf_cnt);
 318 }
 319
 320 static int gdb_putback_char(struct connection *connection, int last_char)
 321 {
 322         struct gdb_connection *gdb_con = connection->priv;
 323
 324         if (gdb_con->buf_p > gdb_con->buffer) {
 325                 *(--gdb_con->buf_p) = last_char;
 326                 gdb_con->buf_cnt++;
 327         } else
 328                 LOG_ERROR("BUG: couldn't put character back");
 329
 330         return ERROR_OK;
 331 }
 332
 333 /* The only way we can detect that the socket is closed is the first time
 334  * we write to it, we will fail. Subsequent write operations will
 335  * succeed. Shudder! */
 336 static int gdb_write(struct connection *connection, void *data, int len)
 337 {
 338         struct gdb_connection *gdb_con = connection->priv;
 339         if (gdb_con->closed)
 340                 return ERROR_SERVER_REMOTE_CLOSED;
 341
 342         if (connection_write(connection, data, len) == len)
 343                 return ERROR_OK;
 344         gdb_con->closed = 1;
 345         return ERROR_SERVER_REMOTE_CLOSED;
 346 }
 347
 348 static int gdb_put_packet_inner(struct connection *connection,
 349                 char *buffer, int len)
 350 {
 351         int i;
 352         unsigned char my_checksum = 0;
 353 #ifdef _DEBUG_GDB_IO_
 354         char *debug_buffer;
 355 #endif
 356         int reply;
 357         int retval;
 358         struct gdb_connection *gdb_con = connection->priv;
 359
 360         for (i = 0; i < len; i++)
 361                 my_checksum += buffer[i];
 362
 363 #ifdef _DEBUG_GDB_IO_
 364         /*
 365          * At this point we should have nothing in the input queue from GDB,
 366          * however sometimes '-' is sent even though we've already received
 367          * an ACK (+) for everything we've sent off.
 368          */
 369         int gotdata;
 370         for (;; ) {
 371                 retval = check_pending(connection, 0, &gotdata);
 372                 if (retval != ERROR_OK)
 373                         return retval;
 374                 if (!gotdata)
 375                         break;
 376                 retval = gdb_get_char(connection, &reply);
 377                 if (retval != ERROR_OK)
 378                         return retval;
 379                 if (reply == '$') {
 380                         /* fix a problem with some IAR tools */
 381                         gdb_putback_char(connection, reply);
 382                         LOG_DEBUG("Unexpected start of new packet");
 383                         break;
 384                 }
 385
 386                 LOG_WARNING("Discard unexpected char %c", reply);
 387         }
 388 #endif
 389
 390         while (1) {
 391 #ifdef _DEBUG_GDB_IO_
 392                 debug_buffer = strndup(buffer, len);
 393                 LOG_DEBUG("sending packet '$%s#%2.2x'", debug_buffer, my_checksum);
 394                 free(debug_buffer);
 395 #endif
 396
 397                 char local_buffer[1024];
 398                 local_buffer[0] = '$';
 399                 if ((size_t)len + 4 <= sizeof(local_buffer)) {
 400                         /* performance gain on smaller packets by only a single call to gdb_write() */
 401                         memcpy(local_buffer + 1, buffer, len++);
 402                         len += snprintf(local_buffer + len, sizeof(local_buffer) - len, "#%02x", my_checksum);
 403                         retval = gdb_write(connection, local_buffer, len);
 404                         if (retval != ERROR_OK)
 405                                 return retval;
 406                 } else {
 407                         /* larger packets are transmitted directly from caller supplied buffer
 408                          * by several calls to gdb_write() to avoid dynamic allocation */
 409                         snprintf(local_buffer + 1, sizeof(local_buffer) - 1, "#%02x", my_checksum);
 410                         retval = gdb_write(connection, local_buffer, 1);
 411                         if (retval != ERROR_OK)
 412                                 return retval;
 413                         retval = gdb_write(connection, buffer, len);
 414                         if (retval != ERROR_OK)
 415                                 return retval;
 416                         retval = gdb_write(connection, local_buffer + 1, 3);
 417                         if (retval != ERROR_OK)
 418                                 return retval;
 419                 }
 420
 421                 if (gdb_con->noack_mode)
 422                         break;
 423
 424                 retval = gdb_get_char(connection, &reply);
 425                 if (retval != ERROR_OK)
 426                         return retval;
 427
 428                 if (reply == '+')
 429                         break;
 430                 else if (reply == '-') {
 431                         /* Stop sending output packets for now */
 432                         log_remove_callback(gdb_log_callback, connection);
 433                         LOG_WARNING("negative reply, retrying");
 434                 } else if (reply == 0x3) {
 435                         gdb_con->ctrl_c = 1;
 436                         retval = gdb_get_char(connection, &reply);
 437                         if (retval != ERROR_OK)
 438                                 return retval;
 439                         if (reply == '+')
 440                                 break;
 441                         else if (reply == '-') {
 442                                 /* Stop sending output packets for now */
 443                                 log_remove_callback(gdb_log_callback, connection);
 444                                 LOG_WARNING("negative reply, retrying");
 445                         } else if (reply == '$') {
 446                                 LOG_ERROR("GDB missing ack(1) - assumed good");
 447                                 gdb_putback_char(connection, reply);
 448                                 return ERROR_OK;
 449                         } else {
 450                                 LOG_ERROR("unknown character(1) 0x%2.2x in reply, dropping connection", reply);
 451                                 gdb_con->closed = 1;
 452                                 return ERROR_SERVER_REMOTE_CLOSED;
 453                         }
 454                 } else if (reply == '$') {
 455                         LOG_ERROR("GDB missing ack(2) - assumed good");
 456                         gdb_putback_char(connection, reply);
 457                         return ERROR_OK;
 458                 } else {
 459                         LOG_ERROR("unknown character(2) 0x%2.2x in reply, dropping connection",
 460                                 reply);
 461                         gdb_con->closed = 1;
 462                         return ERROR_SERVER_REMOTE_CLOSED;
 463                 }
 464         }
 465         if (gdb_con->closed)
 466                 return ERROR_SERVER_REMOTE_CLOSED;
 467
 468         return ERROR_OK;
 469 }
 470
 471 int gdb_put_packet(struct connection *connection, char *buffer, int len)
 472 {
 473         struct gdb_connection *gdb_con = connection->priv;
 474         gdb_con->busy = 1;
 475         int retval = gdb_put_packet_inner(connection, buffer, len);
 476         gdb_con->busy = 0;
 477
 478         /* we sent some data, reset timer for keep alive messages */
 479         kept_alive();
 480
 481         return retval;
 482 }
 483
 484 static inline int fetch_packet(struct connection *connection,
 485                 int *checksum_ok, int noack, int *len, char *buffer)
 486 {
 487         unsigned char my_checksum = 0;
 488         char checksum[3];
 489         int character;
 490         int retval = ERROR_OK;
 491
 492         struct gdb_connection *gdb_con = connection->priv;
 493         my_checksum = 0;
 494         int count = 0;
 495         count = 0;
 496
 497         /* move this over into local variables to use registers and give the
 498          * more freedom to optimize */
 499         char *buf_p = gdb_con->buf_p;
 500         int buf_cnt = gdb_con->buf_cnt;
 501
 502         for (;; ) {
 503                 /* The common case is that we have an entire packet with no escape chars.
 504                  * We need to leave at least 2 bytes in the buffer to have
 505                  * gdb_get_char() update various bits and bobs correctly.
 506                  */
 507                 if ((buf_cnt > 2) && ((buf_cnt + count) < *len)) {
 508                         /* The compiler will struggle a bit with constant propagation and
 509                          * aliasing, so we help it by showing that these values do not
 510                          * change inside the loop
 511                          */
 512                         int i;
 513                         char *buf = buf_p;
 514                         int run = buf_cnt - 2;
 515                         i = 0;
 516                         int done = 0;
 517                         while (i < run) {
 518                                 character = *buf++;
 519                                 i++;
 520                                 if (character == '#') {
 521                                         /* Danger! character can be '#' when esc is
 522                                          * used so we need an explicit boolean for done here. */
 523                                         done = 1;
 524                                         break;
 525                                 }
 526
 527                                 if (character == '}') {
 528                                         /* data transmitted in binary mode (X packet)
 529                                          * uses 0x7d as escape character */
 530                                         my_checksum += character & 0xff;
 531                                         character = *buf++;
 532                                         i++;
 533                                         my_checksum += character & 0xff;
 534                                         buffer[count++] = (character ^ 0x20) & 0xff;
 535                                 } else {
 536                                         my_checksum += character & 0xff;
 537                                         buffer[count++] = character & 0xff;
 538                                 }
 539                         }
 540                         buf_p += i;
 541                         buf_cnt -= i;
 542                         if (done)
 543                                 break;
 544                 }
 545                 if (count > *len) {
 546                         LOG_ERROR("packet buffer too small");
 547                         retval = ERROR_GDB_BUFFER_TOO_SMALL;
 548                         break;
 549                 }
 550
 551                 retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 552                 if (retval != ERROR_OK)
 553                         break;
 554
 555                 if (character == '#')
 556                         break;
 557
 558                 if (character == '}') {
 559                         /* data transmitted in binary mode (X packet)
 560                          * uses 0x7d as escape character */
 561                         my_checksum += character & 0xff;
 562
 563                         retval = gdb_get_char_fast(connection, &character, &buf_p, &buf_cnt);
 564                         if (retval != ERROR_OK)
 565                                 break;
 566
 567                         my_checksum += character & 0xff;
 568                         buffer[count++] = (character ^ 0x20) & 0xff;
 569                 } else {
 570                         my_checksum += character & 0xff;
 571                         buffer[count++] = character & 0xff;
 572                 }
 573         }
 574
 575         gdb_con->buf_p = buf_p;
 576         gdb_con->buf_cnt = buf_cnt;
 577
 578         if (retval != ERROR_OK)
 579                 return retval;
 580
 581         *len = count;
 582
 583         retval = gdb_get_char(connection, &character);
 584         if (retval != ERROR_OK)
 585                 return retval;
 586         checksum[0] = character;
 587         retval = gdb_get_char(connection, &character);
 588         if (retval != ERROR_OK)
 589                 return retval;
 590         checksum[1] = character;
 591         checksum[2] = 0;
 592
 593         if (!noack)
 594                 *checksum_ok = (my_checksum == strtoul(checksum, NULL, 16));
 595
 596         return ERROR_OK;
 597 }
 598
 599 static int gdb_get_packet_inner(struct connection *connection,
 600                 char *buffer, int *len)
 601 {
 602         int character;
 603         int retval;
 604         struct gdb_connection *gdb_con = connection->priv;
 605
 606         while (1) {
 607                 do {
 608                         retval = gdb_get_char(connection, &character);
 609                         if (retval != ERROR_OK)
 610                                 return retval;
 611
 612 #ifdef _DEBUG_GDB_IO_
 613                         LOG_DEBUG("character: '%c'", character);
 614 #endif
 615
 616                         switch (character) {
 617                                 case '$':
 618                                         break;
 619                                 case '+':
 620                                         /* According to the GDB documentation
 621                                          * (https://sourceware.org/gdb/onlinedocs/gdb/Packet-Acknowledgment.html):
 622                                          * "gdb sends a final `+` acknowledgment of the stub's `OK`
 623                                          * response, which can be safely ignored by the stub."
 624                                          * However OpenOCD server already is in noack mode at this
 625                                          * point and instead of ignoring this it was emitting a
 626                                          * warning. This code makes server ignore the first ACK
 627                                          * that will be received after going into noack mode,
 628                                          * warning only about subsequent ACK's. */
 629                                         if (gdb_con->noack_mode > 1) {
 630                                                 LOG_WARNING("acknowledgment received, but no packet pending");
 631                                         } else {
 632                                                 LOG_DEBUG("Received first acknowledgment after entering noack mode. Ignoring it.");
 633                                                 gdb_con->noack_mode = 2;
 634                                         }
 635                                         break;
 636                                 case '-':
 637                                         LOG_WARNING("negative acknowledgment, but no packet pending");
 638                                         break;
 639                                 case 0x3:
 640                                         gdb_con->ctrl_c = 1;
 641                                         *len = 0;
 642                                         return ERROR_OK;
 643                                 default:
 644                                         LOG_WARNING("ignoring character 0x%x", character);
 645                                         break;
 646                         }
 647                 } while (character != '$');
 648
 649                 int checksum_ok = 0;
 650                 /* explicit code expansion here to get faster inlined code in -O3 by not
 651                  * calculating checksum */
 652                 if (gdb_con->noack_mode) {
 653                         retval = fetch_packet(connection, &checksum_ok, 1, len, buffer);
 654                         if (retval != ERROR_OK)
 655                                 return retval;
 656                 } else {
 657                         retval = fetch_packet(connection, &checksum_ok, 0, len, buffer);
 658                         if (retval != ERROR_OK)
 659                                 return retval;
 660                 }
 661
 662                 if (gdb_con->noack_mode) {
 663                         /* checksum is not checked in noack mode */
 664                         break;
 665                 }
 666                 if (checksum_ok) {
 667                         retval = gdb_write(connection, "+", 1);
 668                         if (retval != ERROR_OK)
 669                                 return retval;
 670                         break;
 671                 }
 672         }
 673         if (gdb_con->closed)
 674                 return ERROR_SERVER_REMOTE_CLOSED;
 675
 676         return ERROR_OK;
 677 }
 678
 679 static int gdb_get_packet(struct connection *connection, char *buffer, int *len)
 680 {
 681         struct gdb_connection *gdb_con = connection->priv;
 682         gdb_con->busy = 1;
 683         int retval = gdb_get_packet_inner(connection, buffer, len);
 684         gdb_con->busy = 0;
 685         return retval;
 686 }
 687
 688 static int gdb_output_con(struct connection *connection, const char *line)
 689 {
 690         char *hex_buffer;
 691         int bin_size;
 692
 693         bin_size = strlen(line);
 694
 695         hex_buffer = malloc(bin_size * 2 + 2);
 696         if (hex_buffer == NULL)
 697                 return ERROR_GDB_BUFFER_TOO_SMALL;
 698
 699         hex_buffer[0] = 'O';
 700         int pkt_len = hexify(hex_buffer + 1, line, bin_size, bin_size * 2 + 1);
 701         int retval = gdb_put_packet(connection, hex_buffer, pkt_len + 1);
 702
 703         free(hex_buffer);
 704         return retval;
 705 }
 706
 707 static int gdb_output(struct command_context *context, const char *line)
 708 {
 709         /* this will be dumped to the log and also sent as an O packet if possible */
 710         LOG_USER_N("%s", line);
 711         return ERROR_OK;
 712 }
 713
 714 static void gdb_signal_reply(struct target *target, struct connection *connection)
 715 {
 716         struct gdb_connection *gdb_connection = connection->priv;
 717         char sig_reply[20];
 718         char stop_reason[20];
 719         int sig_reply_len;
 720         int signal_var;
 721
 722         if (target->debug_reason == DBG_REASON_EXIT) {
 723                 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "W00");
 724         } else {
 725                 if (gdb_connection->ctrl_c) {
 726                         signal_var = 0x2;
 727                         gdb_connection->ctrl_c = 0;
 728                 } else
 729                         signal_var = gdb_last_signal(target);
 730
 731                 stop_reason[0] = '\0';
 732                 if (target->debug_reason == DBG_REASON_WATCHPOINT) {
 733                         enum watchpoint_rw hit_wp_type;
 734                         uint32_t hit_wp_address;
 735
 736                         if (watchpoint_hit(target, &hit_wp_type, &hit_wp_address) == ERROR_OK) {
 737
 738                                 switch (hit_wp_type) {
 739                                         case WPT_WRITE:
 740                                                 snprintf(stop_reason, sizeof(stop_reason),
 741                                                                 "watch:%08" PRIx32 ";", hit_wp_address);
 742                                                 break;
 743                                         case WPT_READ:
 744                                                 snprintf(stop_reason, sizeof(stop_reason),
 745                                                                 "rwatch:%08" PRIx32 ";", hit_wp_address);
 746                                                 break;
 747                                         case WPT_ACCESS:
 748                                                 snprintf(stop_reason, sizeof(stop_reason),
 749                                                                 "awatch:%08" PRIx32 ";", hit_wp_address);
 750                                                 break;
 751                                         default:
 752                                                 break;
 753                                 }
 754                         }
 755                 }
 756
 757                 sig_reply_len = snprintf(sig_reply, sizeof(sig_reply), "T%2.2x%s",
 758                                 signal_var, stop_reason);
 759         }
 760
 761         gdb_put_packet(connection, sig_reply, sig_reply_len);
 762         gdb_connection->frontend_state = TARGET_HALTED;
 763         rtos_update_threads(target);
 764 }
 765
 766 static void gdb_fileio_reply(struct target *target, struct connection *connection)
 767 {
 768         struct gdb_connection *gdb_connection = connection->priv;
 769         char fileio_command[256];
 770         int command_len;
 771         bool program_exited = false;
 772
 773         if (strcmp(target->fileio_info->identifier, "open") == 0)
 774                 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 775                                 target->fileio_info->param_1,
 776                                 target->fileio_info->param_2,
 777                                 target->fileio_info->param_3,
 778                                 target->fileio_info->param_4);
 779         else if (strcmp(target->fileio_info->identifier, "close") == 0)
 780                 sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier,
 781                                 target->fileio_info->param_1);
 782         else if (strcmp(target->fileio_info->identifier, "read") == 0)
 783                 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 784                                 target->fileio_info->param_1,
 785                                 target->fileio_info->param_2,
 786                                 target->fileio_info->param_3);
 787         else if (strcmp(target->fileio_info->identifier, "write") == 0)
 788                 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 789                                 target->fileio_info->param_1,
 790                                 target->fileio_info->param_2,
 791                                 target->fileio_info->param_3);
 792         else if (strcmp(target->fileio_info->identifier, "lseek") == 0)
 793                 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 794                                 target->fileio_info->param_1,
 795                                 target->fileio_info->param_2,
 796                                 target->fileio_info->param_3);
 797         else if (strcmp(target->fileio_info->identifier, "rename") == 0)
 798                 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
 799                                 target->fileio_info->param_1,
 800                                 target->fileio_info->param_2,
 801                                 target->fileio_info->param_3,
 802                                 target->fileio_info->param_4);
 803         else if (strcmp(target->fileio_info->identifier, "unlink") == 0)
 804                 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
 805                                 target->fileio_info->param_1,
 806                                 target->fileio_info->param_2);
 807         else if (strcmp(target->fileio_info->identifier, "stat") == 0)
 808                 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 809                                 target->fileio_info->param_1,
 810                                 target->fileio_info->param_2,
 811                                 target->fileio_info->param_3);
 812         else if (strcmp(target->fileio_info->identifier, "fstat") == 0)
 813                 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 814                                 target->fileio_info->param_1,
 815                                 target->fileio_info->param_2);
 816         else if (strcmp(target->fileio_info->identifier, "gettimeofday") == 0)
 817                 sprintf(fileio_command, "F%s,%" PRIx32 ",%" PRIx32, target->fileio_info->identifier,
 818                                 target->fileio_info->param_1,
 819                                 target->fileio_info->param_2);
 820         else if (strcmp(target->fileio_info->identifier, "isatty") == 0)
 821                 sprintf(fileio_command, "F%s,%" PRIx32, target->fileio_info->identifier,
 822                                 target->fileio_info->param_1);
 823         else if (strcmp(target->fileio_info->identifier, "system") == 0)
 824                 sprintf(fileio_command, "F%s,%" PRIx32 "/%" PRIx32, target->fileio_info->identifier,
 825                                 target->fileio_info->param_1,
 826                                 target->fileio_info->param_2);
 827         else if (strcmp(target->fileio_info->identifier, "exit") == 0) {
 828                 /* If target hits exit syscall, report to GDB the program is terminated.
 829                  * In addition, let target run its own exit syscall handler. */
 830                 program_exited = true;
 831                 sprintf(fileio_command, "W%02" PRIx32, target->fileio_info->param_1);
 832         } else {
 833                 LOG_DEBUG("Unknown syscall: %s", target->fileio_info->identifier);
 834
 835                 /* encounter unknown syscall, continue */
 836                 gdb_connection->frontend_state = TARGET_RUNNING;
 837                 target_resume(target, 1, 0x0, 0, 0);
 838                 return;
 839         }
 840
 841         command_len = strlen(fileio_command);
 842         gdb_put_packet(connection, fileio_command, command_len);
 843
 844         if (program_exited) {
 845                 /* Use target_resume() to let target run its own exit syscall handler. */
 846                 gdb_connection->frontend_state = TARGET_RUNNING;
 847                 target_resume(target, 1, 0x0, 0, 0);
 848         } else {
 849                 gdb_connection->frontend_state = TARGET_HALTED;
 850                 rtos_update_threads(target);
 851         }
 852 }
 853
 854 static void gdb_frontend_halted(struct target *target, struct connection *connection)
 855 {
 856         struct gdb_connection *gdb_connection = connection->priv;
 857
 858         /* In the GDB protocol when we are stepping or continuing execution,
 859          * we have a lingering reply. Upon receiving a halted event
 860          * when we have that lingering packet, we reply to the original
 861          * step or continue packet.
 862          *
 863          * Executing monitor commands can bring the target in and
 864          * out of the running state so we'll see lots of TARGET_EVENT_XXX
 865          * that are to be ignored.
 866          */
 867         if (gdb_connection->frontend_state == TARGET_RUNNING) {
 868                 /* stop forwarding log packets! */
 869                 log_remove_callback(gdb_log_callback, connection);
 870
 871                 /* check fileio first */
 872                 if (target_get_gdb_fileio_info(target, target->fileio_info) == ERROR_OK)
 873                         gdb_fileio_reply(target, connection);
 874                 else
 875                         gdb_signal_reply(target, connection);
 876         }
 877 }
 878
 879 static int gdb_target_callback_event_handler(struct target *target,
 880                 enum target_event event, void *priv)
 881 {
 882         int retval;
 883         struct connection *connection = priv;
 884         struct gdb_service *gdb_service = connection->service->priv;
 885
 886         if (gdb_service->target != target)
 887                 return ERROR_OK;
 888
 889         switch (event) {
 890                 case TARGET_EVENT_GDB_HALT:
 891                         gdb_frontend_halted(target, connection);
 892                         break;
 893                 case TARGET_EVENT_HALTED:
 894                         target_call_event_callbacks(target, TARGET_EVENT_GDB_END);
 895                         break;
 896                 case TARGET_EVENT_GDB_FLASH_ERASE_START:
 897                         retval = jtag_execute_queue();
 898                         if (retval != ERROR_OK)
 899                                 return retval;
 900                         break;
 901                 default:
 902                         break;
 903         }
 904
 905         return ERROR_OK;
 906 }
 907
 908 static int gdb_new_connection(struct connection *connection)
 909 {
 910         struct gdb_connection *gdb_connection = malloc(sizeof(struct gdb_connection));
 911         struct gdb_service *gdb_service = connection->service->priv;
 912         int retval;
 913         int initial_ack;
 914
 915         connection->priv = gdb_connection;
 916
 917         /* initialize gdb connection information */
 918         gdb_connection->buf_p = gdb_connection->buffer;
 919         gdb_connection->buf_cnt = 0;
 920         gdb_connection->ctrl_c = 0;
 921         gdb_connection->frontend_state = TARGET_HALTED;
 922         gdb_connection->vflash_image = NULL;
 923         gdb_connection->closed = 0;
 924         gdb_connection->busy = 0;
 925         gdb_connection->noack_mode = 0;
 926         gdb_connection->sync = false;
 927         gdb_connection->mem_write_error = false;
 928         gdb_connection->attached = true;
 929         gdb_connection->target_desc.tdesc = NULL;
 930         gdb_connection->target_desc.tdesc_length = 0;
 931
 932         /* send ACK to GDB for debug request */
 933         gdb_write(connection, "+", 1);
 934
 935         /* output goes through gdb connection */
 936         command_set_output_handler(connection->cmd_ctx, gdb_output, connection);
 937
 938         /* we must remove all breakpoints registered to the target as a previous
 939          * GDB session could leave dangling breakpoints if e.g. communication
 940          * timed out.
 941          */
 942         breakpoint_clear_target(gdb_service->target);
 943         watchpoint_clear_target(gdb_service->target);
 944
 945         /* clean previous rtos session if supported*/
 946         if ((gdb_service->target->rtos) && (gdb_service->target->rtos->type->clean))
 947                 gdb_service->target->rtos->type->clean(gdb_service->target);
 948
 949         /* remove the initial ACK from the incoming buffer */
 950         retval = gdb_get_char(connection, &initial_ack);
 951         if (retval != ERROR_OK)
 952                 return retval;
 953
 954         /* FIX!!!??? would we actually ever receive a + here???
 955          * Not observed.
 956          */
 957         if (initial_ack != '+')
 958                 gdb_putback_char(connection, initial_ack);
 959         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_ATTACH);
 960
 961         if (gdb_use_memory_map) {
 962                 /* Connect must fail if the memory map can't be set up correctly.
 963                  *
 964                  * This will cause an auto_probe to be invoked, which is either
 965                  * a no-op or it will fail when the target isn't ready(e.g. not halted).
 966                  */
 967                 int i;
 968                 for (i = 0; i < flash_get_bank_count(); i++) {
 969                         struct flash_bank *p;
 970                         p = get_flash_bank_by_num_noprobe(i);
 971                         if (p->target != gdb_service->target)
 972                                 continue;
 973                         retval = get_flash_bank_by_num(i, &p);
 974                         if (retval != ERROR_OK) {
 975                                 LOG_ERROR("Connect failed. Consider setting up a gdb-attach event for the target " \
 976                                                 "to prepare target for GDB connect, or use 'gdb_memory_map disable'.");
 977                                 return retval;
 978                         }
 979                 }
 980         }
 981
 982         gdb_actual_connections++;
 983         LOG_DEBUG("New GDB Connection: %d, Target %s, state: %s",
 984                         gdb_actual_connections,
 985                         target_name(gdb_service->target),
 986                         target_state_name(gdb_service->target));
 987
 988         /* DANGER! If we fail subsequently, we must remove this handler,
 989          * otherwise we occasionally see crashes as the timer can invoke the
 990          * callback fn.
 991          *
 992          * register callback to be informed about target events */
 993         target_register_event_callback(gdb_target_callback_event_handler, connection);
 994
 995         return ERROR_OK;
 996 }
 997
 998 static int gdb_connection_closed(struct connection *connection)
 999 {
1000         struct gdb_service *gdb_service = connection->service->priv;
1001         struct gdb_connection *gdb_connection = connection->priv;
1002
1003         /* we're done forwarding messages. Tear down callback before
1004          * cleaning up connection.
1005          */
1006         log_remove_callback(gdb_log_callback, connection);
1007
1008         gdb_actual_connections--;
1009         LOG_DEBUG("GDB Close, Target: %s, state: %s, gdb_actual_connections=%d",
1010                 target_name(gdb_service->target),
1011                 target_state_name(gdb_service->target),
1012                 gdb_actual_connections);
1013
1014         /* see if an image built with vFlash commands is left */
1015         if (gdb_connection->vflash_image) {
1016                 image_close(gdb_connection->vflash_image);
1017                 free(gdb_connection->vflash_image);
1018                 gdb_connection->vflash_image = NULL;
1019         }
1020
1021         /* if this connection registered a debug-message receiver delete it */
1022         delete_debug_msg_receiver(connection->cmd_ctx, gdb_service->target);
1023
1024         if (connection->priv) {
1025                 free(connection->priv);
1026                 connection->priv = NULL;
1027         } else
1028                 LOG_ERROR("BUG: connection->priv == NULL");
1029
1030         target_unregister_event_callback(gdb_target_callback_event_handler, connection);
1031
1032         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_END);
1033
1034         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
1035
1036         return ERROR_OK;
1037 }
1038
1039 static void gdb_send_error(struct connection *connection, uint8_t the_error)
1040 {
1041         char err[4];
1042         snprintf(err, 4, "E%2.2X", the_error);
1043         gdb_put_packet(connection, err, 3);
1044 }
1045
1046 static int gdb_last_signal_packet(struct connection *connection,
1047                 char *packet, int packet_size)
1048 {
1049         struct target *target = get_target_from_connection(connection);
1050         struct gdb_connection *gdb_con = connection->priv;
1051         char sig_reply[4];
1052         int signal_var;
1053
1054         if (!gdb_con->attached) {
1055                 /* if we are here we have received a kill packet
1056                  * reply W stop reply otherwise gdb gets very unhappy */
1057                 gdb_put_packet(connection, "W00", 3);
1058                 return ERROR_OK;
1059         }
1060
1061         signal_var = gdb_last_signal(target);
1062
1063         snprintf(sig_reply, 4, "S%2.2x", signal_var);
1064         gdb_put_packet(connection, sig_reply, 3);
1065
1066         return ERROR_OK;
1067 }
1068
1069 static inline int gdb_reg_pos(struct target *target, int pos, int len)
1070 {
1071         if (target->endianness == TARGET_LITTLE_ENDIAN)
1072                 return pos;
1073         else
1074                 return len - 1 - pos;
1075 }
1076
1077 /* Convert register to string of bytes. NB! The # of bits in the
1078  * register might be non-divisible by 8(a byte), in which
1079  * case an entire byte is shown.
1080  *
1081  * NB! the format on the wire is the target endianness
1082  *
1083  * The format of reg->value is little endian
1084  *
1085  */
1086 static void gdb_str_to_target(struct target *target,
1087                 char *tstr, struct reg *reg)
1088 {
1089         int i;
1090
1091         uint8_t *buf;
1092         int buf_len;
1093         buf = reg->value;
1094         buf_len = DIV_ROUND_UP(reg->size, 8);
1095
1096         for (i = 0; i < buf_len; i++) {
1097                 int j = gdb_reg_pos(target, i, buf_len);
1098                 tstr += sprintf(tstr, "%02x", buf[j]);
1099         }
1100 }
1101
1102 /* copy over in register buffer */
1103 static void gdb_target_to_reg(struct target *target,
1104                 char *tstr, int str_len, uint8_t *bin)
1105 {
1106         if (str_len % 2) {
1107                 LOG_ERROR("BUG: gdb value with uneven number of characters encountered");
1108                 exit(-1);
1109         }
1110
1111         int i;
1112         for (i = 0; i < str_len; i += 2) {
1113                 unsigned t;
1114                 if (sscanf(tstr + i, "%02x", &t) != 1) {
1115                         LOG_ERROR("BUG: unable to convert register value");
1116                         exit(-1);
1117                 }
1118
1119                 int j = gdb_reg_pos(target, i/2, str_len/2);
1120                 bin[j] = t;
1121         }
1122 }
1123
1124 static int gdb_get_registers_packet(struct connection *connection,
1125                 char *packet, int packet_size)
1126 {
1127         struct target *target = get_target_from_connection(connection);
1128         struct reg **reg_list;
1129         int reg_list_size;
1130         int retval;
1131         int reg_packet_size = 0;
1132         char *reg_packet;
1133         char *reg_packet_p;
1134         int i;
1135
1136 #ifdef _DEBUG_GDB_IO_
1137         LOG_DEBUG("-");
1138 #endif
1139
1140         if ((target->rtos != NULL) && (ERROR_OK == rtos_get_gdb_reg_list(connection)))
1141                 return ERROR_OK;
1142
1143         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size,
1144                         REG_CLASS_GENERAL);
1145         if (retval != ERROR_OK)
1146                 return gdb_error(connection, retval);
1147
1148         for (i = 0; i < reg_list_size; i++)
1149                 reg_packet_size += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1150
1151         assert(reg_packet_size > 0);
1152
1153         reg_packet = malloc(reg_packet_size + 1); /* plus one for string termination null */
1154         reg_packet_p = reg_packet;
1155
1156         for (i = 0; i < reg_list_size; i++) {
1157                 if (!reg_list[i]->valid)
1158                         reg_list[i]->type->get(reg_list[i]);
1159                 gdb_str_to_target(target, reg_packet_p, reg_list[i]);
1160                 reg_packet_p += DIV_ROUND_UP(reg_list[i]->size, 8) * 2;
1161         }
1162
1163 #ifdef _DEBUG_GDB_IO_
1164         {
1165                 char *reg_packet_p_debug;
1166                 reg_packet_p_debug = strndup(reg_packet, reg_packet_size);
1167                 LOG_DEBUG("reg_packet: %s", reg_packet_p_debug);
1168                 free(reg_packet_p_debug);
1169         }
1170 #endif
1171
1172         gdb_put_packet(connection, reg_packet, reg_packet_size);
1173         free(reg_packet);
1174
1175         free(reg_list);
1176
1177         return ERROR_OK;
1178 }
1179
1180 static int gdb_set_registers_packet(struct connection *connection,
1181                 char *packet, int packet_size)
1182 {
1183         struct target *target = get_target_from_connection(connection);
1184         int i;
1185         struct reg **reg_list;
1186         int reg_list_size;
1187         int retval;
1188         char *packet_p;
1189
1190 #ifdef _DEBUG_GDB_IO_
1191         LOG_DEBUG("-");
1192 #endif
1193
1194         /* skip command character */
1195         packet++;
1196         packet_size--;
1197
1198         if (packet_size % 2) {
1199                 LOG_WARNING("GDB set_registers packet with uneven characters received, dropping connection");
1200                 return ERROR_SERVER_REMOTE_CLOSED;
1201         }
1202
1203         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size,
1204                         REG_CLASS_GENERAL);
1205         if (retval != ERROR_OK)
1206                 return gdb_error(connection, retval);
1207
1208         packet_p = packet;
1209         for (i = 0; i < reg_list_size; i++) {
1210                 uint8_t *bin_buf;
1211                 int chars = (DIV_ROUND_UP(reg_list[i]->size, 8) * 2);
1212
1213                 if (packet_p + chars > packet + packet_size)
1214                         LOG_ERROR("BUG: register packet is too small for registers");
1215
1216                 bin_buf = malloc(DIV_ROUND_UP(reg_list[i]->size, 8));
1217                 gdb_target_to_reg(target, packet_p, chars, bin_buf);
1218
1219                 reg_list[i]->type->set(reg_list[i], bin_buf);
1220
1221                 /* advance packet pointer */
1222                 packet_p += chars;
1223
1224                 free(bin_buf);
1225         }
1226
1227         /* free struct reg *reg_list[] array allocated by get_gdb_reg_list */
1228         free(reg_list);
1229
1230         gdb_put_packet(connection, "OK", 2);
1231
1232         return ERROR_OK;
1233 }
1234
1235 static int gdb_get_register_packet(struct connection *connection,
1236         char *packet, int packet_size)
1237 {
1238         struct target *target = get_target_from_connection(connection);
1239         char *reg_packet;
1240         int reg_num = strtoul(packet + 1, NULL, 16);
1241         struct reg **reg_list;
1242         int reg_list_size;
1243         int retval;
1244
1245 #ifdef _DEBUG_GDB_IO_
1246         LOG_DEBUG("-");
1247 #endif
1248
1249         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size,
1250                         REG_CLASS_ALL);
1251         if (retval != ERROR_OK)
1252                 return gdb_error(connection, retval);
1253
1254         if (reg_list_size <= reg_num) {
1255                 LOG_ERROR("gdb requested a non-existing register");
1256                 return ERROR_SERVER_REMOTE_CLOSED;
1257         }
1258
1259         if (!reg_list[reg_num]->valid)
1260                 reg_list[reg_num]->type->get(reg_list[reg_num]);
1261
1262         reg_packet = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2 + 1); /* plus one for string termination null */
1263
1264         gdb_str_to_target(target, reg_packet, reg_list[reg_num]);
1265
1266         gdb_put_packet(connection, reg_packet, DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1267
1268         free(reg_list);
1269         free(reg_packet);
1270
1271         return ERROR_OK;
1272 }
1273
1274 static int gdb_set_register_packet(struct connection *connection,
1275         char *packet, int packet_size)
1276 {
1277         struct target *target = get_target_from_connection(connection);
1278         char *separator;
1279         uint8_t *bin_buf;
1280         int reg_num = strtoul(packet + 1, &separator, 16);
1281         struct reg **reg_list;
1282         int reg_list_size;
1283         int retval;
1284
1285         LOG_DEBUG("-");
1286
1287         retval = target_get_gdb_reg_list(target, &reg_list, &reg_list_size,
1288                         REG_CLASS_ALL);
1289         if (retval != ERROR_OK)
1290                 return gdb_error(connection, retval);
1291
1292         if (reg_list_size <= reg_num) {
1293                 LOG_ERROR("gdb requested a non-existing register");
1294                 return ERROR_SERVER_REMOTE_CLOSED;
1295         }
1296
1297         if (*separator != '=') {
1298                 LOG_ERROR("GDB 'set register packet', but no '=' following the register number");
1299                 return ERROR_SERVER_REMOTE_CLOSED;
1300         }
1301
1302         /* convert from GDB-string (target-endian) to hex-string (big-endian) */
1303         bin_buf = malloc(DIV_ROUND_UP(reg_list[reg_num]->size, 8));
1304         int chars = (DIV_ROUND_UP(reg_list[reg_num]->size, 8) * 2);
1305
1306         if ((unsigned int)chars != strlen(separator + 1)) {
1307                 LOG_ERROR("gdb sent a packet with wrong register size");
1308                 free(bin_buf);
1309                 return ERROR_SERVER_REMOTE_CLOSED;
1310         }
1311
1312         gdb_target_to_reg(target, separator + 1, chars, bin_buf);
1313
1314         reg_list[reg_num]->type->set(reg_list[reg_num], bin_buf);
1315
1316         gdb_put_packet(connection, "OK", 2);
1317
1318         free(bin_buf);
1319         free(reg_list);
1320
1321         return ERROR_OK;
1322 }
1323
1324 /* No attempt is made to translate the "retval" to
1325  * GDB speak. This has to be done at the calling
1326  * site as no mapping really exists.
1327  */
1328 static int gdb_error(struct connection *connection, int retval)
1329 {
1330         LOG_DEBUG("Reporting %i to GDB as generic error", retval);
1331         gdb_send_error(connection, EFAULT);
1332         return ERROR_OK;
1333 }
1334
1335 /* We don't have to worry about the default 2 second timeout for GDB packets,
1336  * because GDB breaks up large memory reads into smaller reads.
1337  *
1338  * 8191 bytes by the looks of it. Why 8191 bytes instead of 8192?????
1339  */
1340 static int gdb_read_memory_packet(struct connection *connection,
1341                 char *packet, int packet_size)
1342 {
1343         struct target *target = get_target_from_connection(connection);
1344         char *separator;
1345         uint32_t addr = 0;
1346         uint32_t len = 0;
1347
1348         uint8_t *buffer;
1349         char *hex_buffer;
1350
1351         int retval = ERROR_OK;
1352
1353         /* skip command character */
1354         packet++;
1355
1356         addr = strtoul(packet, &separator, 16);
1357
1358         if (*separator != ',') {
1359                 LOG_ERROR("incomplete read memory packet received, dropping connection");
1360                 return ERROR_SERVER_REMOTE_CLOSED;
1361         }
1362
1363         len = strtoul(separator + 1, NULL, 16);
1364
1365         if (!len) {
1366                 LOG_WARNING("invalid read memory packet received (len == 0)");
1367                 gdb_put_packet(connection, NULL, 0);
1368                 return ERROR_OK;
1369         }
1370
1371         buffer = malloc(len);
1372
1373         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1374
1375         retval = target_read_buffer(target, addr, len, buffer);
1376
1377         if ((retval != ERROR_OK) && !gdb_report_data_abort) {
1378                 /* TODO : Here we have to lie and send back all zero's lest stack traces won't work.
1379                  * At some point this might be fixed in GDB, in which case this code can be removed.
1380                  *
1381                  * OpenOCD developers are acutely aware of this problem, but there is nothing
1382                  * gained by involving the user in this problem that hopefully will get resolved
1383                  * eventually
1384                  *
1385                  * http://sourceware.org/cgi-bin/gnatsweb.pl? \
1386                  * cmd = view%20audit-trail&database = gdb&pr = 2395
1387                  *
1388                  * For now, the default is to fix up things to make current GDB versions work.
1389                  * This can be overwritten using the gdb_report_data_abort <'enable'|'disable'> command.
1390                  */
1391                 memset(buffer, 0, len);
1392                 retval = ERROR_OK;
1393         }
1394
1395         if (retval == ERROR_OK) {
1396                 hex_buffer = malloc(len * 2 + 1);
1397
1398                 int pkt_len = hexify(hex_buffer, (char *)buffer, len, len * 2 + 1);
1399
1400                 gdb_put_packet(connection, hex_buffer, pkt_len);
1401
1402                 free(hex_buffer);
1403         } else
1404                 retval = gdb_error(connection, retval);
1405
1406         free(buffer);
1407
1408         return retval;
1409 }
1410
1411 static int gdb_write_memory_packet(struct connection *connection,
1412                 char *packet, int packet_size)
1413 {
1414         struct target *target = get_target_from_connection(connection);
1415         char *separator;
1416         uint32_t addr = 0;
1417         uint32_t len = 0;
1418
1419         uint8_t *buffer;
1420         int retval;
1421
1422         /* skip command character */
1423         packet++;
1424
1425         addr = strtoul(packet, &separator, 16);
1426
1427         if (*separator != ',') {
1428                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1429                 return ERROR_SERVER_REMOTE_CLOSED;
1430         }
1431
1432         len = strtoul(separator + 1, &separator, 16);
1433
1434         if (*(separator++) != ':') {
1435                 LOG_ERROR("incomplete write memory packet received, dropping connection");
1436                 return ERROR_SERVER_REMOTE_CLOSED;
1437         }
1438
1439         buffer = malloc(len);
1440
1441         LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1442
1443         if (unhexify((char *)buffer, separator, len) != (int)len)
1444                 LOG_ERROR("unable to decode memory packet");
1445
1446         retval = target_write_buffer(target, addr, len, buffer);
1447
1448         if (retval == ERROR_OK)
1449                 gdb_put_packet(connection, "OK", 2);
1450         else
1451                 retval = gdb_error(connection, retval);
1452
1453         free(buffer);
1454
1455         return retval;
1456 }
1457
1458 static int gdb_write_memory_binary_packet(struct connection *connection,
1459                 char *packet, int packet_size)
1460 {
1461         struct target *target = get_target_from_connection(connection);
1462         char *separator;
1463         uint32_t addr = 0;
1464         uint32_t len = 0;
1465
1466         int retval = ERROR_OK;
1467
1468         /* skip command character */
1469         packet++;
1470
1471         addr = strtoul(packet, &separator, 16);
1472
1473         if (*separator != ',') {
1474                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1475                 return ERROR_SERVER_REMOTE_CLOSED;
1476         }
1477
1478         len = strtoul(separator + 1, &separator, 16);
1479
1480         if (*(separator++) != ':') {
1481                 LOG_ERROR("incomplete write memory binary packet received, dropping connection");
1482                 return ERROR_SERVER_REMOTE_CLOSED;
1483         }
1484
1485         struct gdb_connection *gdb_connection = connection->priv;
1486
1487         if (gdb_connection->mem_write_error) {
1488                 retval = ERROR_FAIL;
1489                 /* now that we have reported the memory write error, we can clear the condition */
1490                 gdb_connection->mem_write_error = false;
1491         }
1492
1493         /* By replying the packet *immediately* GDB will send us a new packet
1494          * while we write the last one to the target.
1495          */
1496         if (retval == ERROR_OK)
1497                 gdb_put_packet(connection, "OK", 2);
1498         else {
1499                 retval = gdb_error(connection, retval);
1500                 if (retval != ERROR_OK)
1501                         return retval;
1502         }
1503
1504         if (len) {
1505                 LOG_DEBUG("addr: 0x%8.8" PRIx32 ", len: 0x%8.8" PRIx32 "", addr, len);
1506
1507                 retval = target_write_buffer(target, addr, len, (uint8_t *)separator);
1508                 if (retval != ERROR_OK)
1509                         gdb_connection->mem_write_error = true;
1510         }
1511
1512         return ERROR_OK;
1513 }
1514
1515 static int gdb_step_continue_packet(struct connection *connection,
1516                 char *packet, int packet_size)
1517 {
1518         struct target *target = get_target_from_connection(connection);
1519         int current = 0;
1520         uint32_t address = 0x0;
1521         int retval = ERROR_OK;
1522
1523         LOG_DEBUG("-");
1524
1525         if (packet_size > 1)
1526                 address = strtoul(packet + 1, NULL, 16);
1527         else
1528                 current = 1;
1529
1530         gdb_running_type = packet[0];
1531         if (packet[0] == 'c') {
1532                 LOG_DEBUG("continue");
1533                 /* resume at current address, don't handle breakpoints, not debugging */
1534                 retval = target_resume(target, current, address, 0, 0);
1535         } else if (packet[0] == 's') {
1536                 LOG_DEBUG("step");
1537                 /* step at current or address, don't handle breakpoints */
1538                 retval = target_step(target, current, address, 0);
1539         }
1540         return retval;
1541 }
1542
1543 static int gdb_breakpoint_watchpoint_packet(struct connection *connection,
1544                 char *packet, int packet_size)
1545 {
1546         struct target *target = get_target_from_connection(connection);
1547         int type;
1548         enum breakpoint_type bp_type = BKPT_SOFT /* dummy init to avoid warning */;
1549         enum watchpoint_rw wp_type = WPT_READ /* dummy init to avoid warning */;
1550         uint32_t address;
1551         uint32_t size;
1552         char *separator;
1553         int retval;
1554
1555         LOG_DEBUG("-");
1556
1557         type = strtoul(packet + 1, &separator, 16);
1558
1559         if (type == 0)  /* memory breakpoint */
1560                 bp_type = BKPT_SOFT;
1561         else if (type == 1)     /* hardware breakpoint */
1562                 bp_type = BKPT_HARD;
1563         else if (type == 2)     /* write watchpoint */
1564                 wp_type = WPT_WRITE;
1565         else if (type == 3)     /* read watchpoint */
1566                 wp_type = WPT_READ;
1567         else if (type == 4)     /* access watchpoint */
1568                 wp_type = WPT_ACCESS;
1569         else {
1570                 LOG_ERROR("invalid gdb watch/breakpoint type(%d), dropping connection", type);
1571                 return ERROR_SERVER_REMOTE_CLOSED;
1572         }
1573
1574         if (gdb_breakpoint_override && ((bp_type == BKPT_SOFT) || (bp_type == BKPT_HARD)))
1575                 bp_type = gdb_breakpoint_override_type;
1576
1577         if (*separator != ',') {
1578                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1579                 return ERROR_SERVER_REMOTE_CLOSED;
1580         }
1581
1582         address = strtoul(separator + 1, &separator, 16);
1583
1584         if (*separator != ',') {
1585                 LOG_ERROR("incomplete breakpoint/watchpoint packet received, dropping connection");
1586                 return ERROR_SERVER_REMOTE_CLOSED;
1587         }
1588
1589         size = strtoul(separator + 1, &separator, 16);
1590
1591         switch (type) {
1592                 case 0:
1593                 case 1:
1594                         if (packet[0] == 'Z') {
1595                                 retval = breakpoint_add(target, address, size, bp_type);
1596                                 if (retval != ERROR_OK) {
1597                                         retval = gdb_error(connection, retval);
1598                                         if (retval != ERROR_OK)
1599                                                 return retval;
1600                                 } else
1601                                         gdb_put_packet(connection, "OK", 2);
1602                         } else {
1603                                 breakpoint_remove(target, address);
1604                                 gdb_put_packet(connection, "OK", 2);
1605                         }
1606                         break;
1607                 case 2:
1608                 case 3:
1609                 case 4:
1610                 {
1611                         if (packet[0] == 'Z') {
1612                                 retval = watchpoint_add(target, address, size, wp_type, 0, 0xffffffffu);
1613                                 if (retval != ERROR_OK) {
1614                                         retval = gdb_error(connection, retval);
1615                                         if (retval != ERROR_OK)
1616                                                 return retval;
1617                                 } else
1618                                         gdb_put_packet(connection, "OK", 2);
1619                         } else {
1620                                 watchpoint_remove(target, address);
1621                                 gdb_put_packet(connection, "OK", 2);
1622                         }
1623                         break;
1624                 }
1625                 default:
1626                         break;
1627         }
1628
1629         return ERROR_OK;
1630 }
1631
1632 /* print out a string and allocate more space as needed,
1633  * mainly used for XML at this point
1634  */
1635 static void xml_printf(int *retval, char **xml, int *pos, int *size,
1636                 const char *fmt, ...)
1637 {
1638         if (*retval != ERROR_OK)
1639                 return;
1640         int first = 1;
1641
1642         for (;; ) {
1643                 if ((*xml == NULL) || (!first)) {
1644                         /* start by 0 to exercise all the code paths.
1645                          * Need minimum 2 bytes to fit 1 char and 0 terminator. */
1646
1647                         *size = *size * 2 + 2;
1648                         char *t = *xml;
1649                         *xml = realloc(*xml, *size);
1650                         if (*xml == NULL) {
1651                                 if (t)
1652                                         free(t);
1653                                 *retval = ERROR_SERVER_REMOTE_CLOSED;
1654                                 return;
1655                         }
1656                 }
1657
1658                 va_list ap;
1659                 int ret;
1660                 va_start(ap, fmt);
1661                 ret = vsnprintf(*xml + *pos, *size - *pos, fmt, ap);
1662                 va_end(ap);
1663                 if ((ret > 0) && ((ret + 1) < *size - *pos)) {
1664                         *pos += ret;
1665                         return;
1666                 }
1667                 /* there was just enough or not enough space, allocate more. */
1668                 first = 0;
1669         }
1670 }
1671
1672 static int decode_xfer_read(char *buf, char **annex, int *ofs, unsigned int *len)
1673 {
1674         char *separator;
1675
1676         /* Extract and NUL-terminate the annex. */
1677         *annex = buf;
1678         while (*buf && *buf != ':')
1679                 buf++;
1680         if (*buf == '\0')
1681                 return -1;
1682         *buf++ = 0;
1683
1684         /* After the read marker and annex, qXfer looks like a
1685          * traditional 'm' packet. */
1686
1687         *ofs = strtoul(buf, &separator, 16);
1688
1689         if (*separator != ',')
1690                 return -1;
1691
1692         *len = strtoul(separator + 1, NULL, 16);
1693
1694         return 0;
1695 }
1696
1697 static int compare_bank(const void *a, const void *b)
1698 {
1699         struct flash_bank *b1, *b2;
1700         b1 = *((struct flash_bank **)a);
1701         b2 = *((struct flash_bank **)b);
1702
1703         if (b1->base == b2->base)
1704                 return 0;
1705         else if (b1->base > b2->base)
1706                 return 1;
1707         else
1708                 return -1;
1709 }
1710
1711 static int gdb_memory_map(struct connection *connection,
1712                 char *packet, int packet_size)
1713 {
1714         /* We get away with only specifying flash here. Regions that are not
1715          * specified are treated as if we provided no memory map(if not we
1716          * could detect the holes and mark them as RAM).
1717          * Normally we only execute this code once, but no big deal if we
1718          * have to regenerate it a couple of times.
1719          */
1720
1721         struct target *target = get_target_from_connection(connection);
1722         struct flash_bank *p;
1723         char *xml = NULL;
1724         int size = 0;
1725         int pos = 0;
1726         int retval = ERROR_OK;
1727         struct flash_bank **banks;
1728         int offset;
1729         int length;
1730         char *separator;
1731         uint32_t ram_start = 0;
1732         int i;
1733         int target_flash_banks = 0;
1734
1735         /* skip command character */
1736         packet += 23;
1737
1738         offset = strtoul(packet, &separator, 16);
1739         length = strtoul(separator + 1, &separator, 16);
1740
1741         xml_printf(&retval, &xml, &pos, &size, "<memory-map>\n");
1742
1743         /* Sort banks in ascending order.  We need to report non-flash
1744          * memory as ram (or rather read/write) by default for GDB, since
1745          * it has no concept of non-cacheable read/write memory (i/o etc).
1746          *
1747          * FIXME Most non-flash addresses are *NOT* RAM!  Don't lie.
1748          * Current versions of GDB assume unlisted addresses are RAM...
1749          */
1750         banks = malloc(sizeof(struct flash_bank *)*flash_get_bank_count());
1751
1752         for (i = 0; i < flash_get_bank_count(); i++) {
1753                 p = get_flash_bank_by_num_noprobe(i);
1754                 if (p->target != target)
1755                         continue;
1756                 retval = get_flash_bank_by_num(i, &p);
1757                 if (retval != ERROR_OK) {
1758                         free(banks);
1759                         gdb_error(connection, retval);
1760                         return retval;
1761                 }
1762                 banks[target_flash_banks++] = p;
1763         }
1764
1765         qsort(banks, target_flash_banks, sizeof(struct flash_bank *),
1766                 compare_bank);
1767
1768         for (i = 0; i < target_flash_banks; i++) {
1769                 int j;
1770                 unsigned sector_size = 0;
1771                 uint32_t start;
1772
1773                 p = banks[i];
1774                 start = p->base;
1775
1776                 if (ram_start < p->base)
1777                         xml_printf(&retval, &xml, &pos, &size,
1778                                 "<memory type=\"ram\" start=\"0x%x\" "
1779                                 "length=\"0x%x\"/>\n",
1780                                 ram_start, p->base - ram_start);
1781
1782                 /* Report adjacent groups of same-size sectors.  So for
1783                  * example top boot CFI flash will list an initial region
1784                  * with several large sectors (maybe 128KB) and several
1785                  * smaller ones at the end (maybe 32KB).  STR7 will have
1786                  * regions with 8KB, 32KB, and 64KB sectors; etc.
1787                  */
1788                 for (j = 0; j < p->num_sectors; j++) {
1789                         unsigned group_len;
1790
1791                         /* Maybe start a new group of sectors. */
1792                         if (sector_size == 0) {
1793                                 start = p->base + p->sectors[j].offset;
1794                                 xml_printf(&retval, &xml, &pos, &size,
1795                                         "<memory type=\"flash\" "
1796                                         "start=\"0x%x\" ",
1797                                         start);
1798                                 sector_size = p->sectors[j].size;
1799                         }
1800
1801                         /* Does this finish a group of sectors?
1802                          * If not, continue an already-started group.
1803                          */
1804                         if (j == p->num_sectors - 1)
1805                                 group_len = (p->base + p->size) - start;
1806                         else if (p->sectors[j + 1].size != sector_size)
1807                                 group_len = p->base + p->sectors[j + 1].offset
1808                                         - start;
1809                         else
1810                                 continue;
1811
1812                         xml_printf(&retval, &xml, &pos, &size,
1813                                 "length=\"0x%x\">\n"
1814                                 "<property name=\"blocksize\">"
1815                                 "0x%x</property>\n"
1816                                 "</memory>\n",
1817                                 group_len,
1818                                 sector_size);
1819                         sector_size = 0;
1820                 }
1821
1822                 ram_start = p->base + p->size;
1823         }
1824
1825         if (ram_start != 0)
1826                 xml_printf(&retval, &xml, &pos, &size,
1827                         "<memory type=\"ram\" start=\"0x%x\" "
1828                         "length=\"0x%x\"/>\n",
1829                         ram_start, 0-ram_start);
1830         /* ELSE a flash chip could be at the very end of the 32 bit address
1831          * space, in which case ram_start will be precisely 0
1832          */
1833
1834         free(banks);
1835         banks = NULL;
1836
1837         xml_printf(&retval, &xml, &pos, &size, "</memory-map>\n");
1838
1839         if (retval != ERROR_OK) {
1840                 gdb_error(connection, retval);
1841                 return retval;
1842         }
1843
1844         if (offset + length > pos)
1845                 length = pos - offset;
1846
1847         char *t = malloc(length + 1);
1848         t[0] = 'l';
1849         memcpy(t + 1, xml + offset, length);
1850         gdb_put_packet(connection, t, length + 1);
1851
1852         free(t);
1853         free(xml);
1854         return ERROR_OK;
1855 }
1856
1857 static const char *gdb_get_reg_type_name(enum reg_type type)
1858 {
1859         switch (type) {
1860                 case REG_TYPE_INT:
1861                         return "int";
1862                 case REG_TYPE_INT8:
1863                         return "int8";
1864                 case REG_TYPE_INT16:
1865                         return "int16";
1866                 case REG_TYPE_INT32:
1867                         return "int32";
1868                 case REG_TYPE_INT64:
1869                         return "int64";
1870                 case REG_TYPE_INT128:
1871                         return "int128";
1872                 case REG_TYPE_UINT8:
1873                         return "uint8";
1874                 case REG_TYPE_UINT16:
1875                         return "uint16";
1876                 case REG_TYPE_UINT32:
1877                         return "uint32";
1878                 case REG_TYPE_UINT64:
1879                         return "uint64";
1880                 case REG_TYPE_UINT128:
1881                         return "uint128";
1882                 case REG_TYPE_CODE_PTR:
1883                         return "code_ptr";
1884                 case REG_TYPE_DATA_PTR:
1885                         return "data_ptr";
1886                 case REG_TYPE_FLOAT:
1887                         return "float";
1888                 case REG_TYPE_IEEE_SINGLE:
1889                         return "ieee_single";
1890                 case REG_TYPE_IEEE_DOUBLE:
1891                         return "ieee_double";
1892                 case REG_TYPE_ARCH_DEFINED:
1893                         return "int"; /* return arbitrary string to avoid compile warning. */
1894         }
1895
1896         return "int"; /* "int" as default value */
1897 }
1898
1899 static int gdb_generate_reg_type_description(struct target *target,
1900                 char **tdesc, int *pos, int *size, struct reg_data_type *type)
1901 {
1902         int retval = ERROR_OK;
1903
1904         if (type->type_class == REG_TYPE_CLASS_VECTOR) {
1905                 /* <vector id="id" type="type" count="count"/> */
1906                 xml_printf(&retval, tdesc, pos, size,
1907                                 "<vector id=\"%s\" type=\"%s\" count=\"%d\"/>\n",
1908                                 type->id, type->reg_type_vector->type->id,
1909                                 type->reg_type_vector->count);
1910
1911         } else if (type->type_class == REG_TYPE_CLASS_UNION) {
1912                 /* <union id="id">
1913                  *  <field name="name" type="type"/> ...
1914                  * </union> */
1915                 xml_printf(&retval, tdesc, pos, size,
1916                                 "<union id=\"%s\">\n",
1917                                 type->id);
1918
1919                 struct reg_data_type_union_field *field;
1920                 field = type->reg_type_union->fields;
1921                 while (field != NULL) {
1922                         xml_printf(&retval, tdesc, pos, size,
1923                                         "<field name=\"%s\" type=\"%s\"/>\n",
1924                                         field->name, field->type->id);
1925
1926                         field = field->next;
1927                 }
1928
1929                 xml_printf(&retval, tdesc, pos, size,
1930                                 "</union>\n");
1931
1932         } else if (type->type_class == REG_TYPE_CLASS_STRUCT) {
1933                 struct reg_data_type_struct_field *field;
1934                 field = type->reg_type_struct->fields;
1935
1936                 if (field->use_bitfields) {
1937                         /* <struct id="id" size="size">
1938                          *  <field name="name" start="start" end="end"/> ...
1939                          * </struct> */
1940                         xml_printf(&retval, tdesc, pos, size,
1941                                         "<struct id=\"%s\" size=\"%d\">\n",
1942                                         type->id, type->reg_type_struct->size);
1943                         while (field != NULL) {
1944                                 xml_printf(&retval, tdesc, pos, size,
1945                                                 "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
1946                                                 field->name, field->bitfield->start,
1947                                                 field->bitfield->end);
1948
1949                                 field = field->next;
1950                         }
1951                 } else {
1952                         /* <struct id="id">
1953                          *  <field name="name" type="type"/> ...
1954                          * </struct> */
1955                         xml_printf(&retval, tdesc, pos, size,
1956                                         "<struct id=\"%s\">\n",
1957                                         type->id);
1958                         while (field != NULL) {
1959                                 xml_printf(&retval, tdesc, pos, size,
1960                                                 "<field name=\"%s\" type=\"%s\"/>\n",
1961                                                 field->name, field->type->id);
1962
1963                                 field = field->next;
1964                         }
1965                 }
1966
1967                 xml_printf(&retval, tdesc, pos, size,
1968                                 "</struct>\n");
1969
1970         } else if (type->type_class == REG_TYPE_CLASS_FLAGS) {
1971                 /* <flags id="id" size="size">
1972                  *  <field name="name" start="start" end="end"/> ...
1973                  * </flags> */
1974                 xml_printf(&retval, tdesc, pos, size,
1975                                 "<flags id=\"%s\" size=\"%d\">\n",
1976                                 type->id, type->reg_type_flags->size);
1977
1978                 struct reg_data_type_flags_field *field;
1979                 field = type->reg_type_flags->fields;
1980                 while (field != NULL) {
1981                         xml_printf(&retval, tdesc, pos, size,
1982                                         "<field name=\"%s\" start=\"%d\" end=\"%d\"/>\n",
1983                                         field->name, field->bitfield->start, field->bitfield->end);
1984
1985                         field = field->next;
1986                 }
1987
1988                 xml_printf(&retval, tdesc, pos, size,
1989                                 "</flags>\n");
1990
1991         }
1992
1993         return ERROR_OK;
1994 }
1995
1996 /* Get a list of available target registers features. feature_list must
1997  * be freed by caller.
1998  */
1999 static int get_reg_features_list(struct target *target, char **feature_list[], int *feature_list_size,
2000                 struct reg **reg_list, int reg_list_size)
2001 {
2002         int tbl_sz = 0;
2003
2004         /* Start with only one element */
2005         *feature_list = calloc(1, sizeof(char *));
2006
2007         for (int i = 0; i < reg_list_size; i++) {
2008                 if (reg_list[i]->exist == false)
2009                         continue;
2010
2011                 if (reg_list[i]->feature != NULL
2012                         && reg_list[i]->feature->name != NULL
2013                         && (strcmp(reg_list[i]->feature->name, ""))) {
2014                         /* We found a feature, check if the feature is already in the
2015                          * table. If not, allocate a new entry for the table and
2016                          * put the new feature in it.
2017                          */
2018                         for (int j = 0; j < (tbl_sz + 1); j++) {
2019                                 if (!((*feature_list)[j])) {
2020                                         (*feature_list)[tbl_sz++] = strdup(reg_list[i]->feature->name);
2021                                         *feature_list = realloc(*feature_list, sizeof(char *) * (tbl_sz + 1));
2022                                         (*feature_list)[tbl_sz] = NULL;
2023                                         break;
2024                                 } else {
2025                                         if (!strcmp((*feature_list)[j], reg_list[i]->feature->name))
2026                                                 break;
2027                                 }
2028                         }
2029                 }
2030         }
2031
2032         if (feature_list_size)
2033                 *feature_list_size = tbl_sz;
2034
2035         return ERROR_OK;
2036 }
2037
2038 static int gdb_generate_target_description(struct target *target, char **tdesc_out)
2039 {
2040         int retval = ERROR_OK;
2041         struct reg **reg_list;
2042         int reg_list_size;
2043         char *tdesc = NULL;
2044         int pos = 0;
2045         int size = 0;
2046
2047         retval = target_get_gdb_reg_list(target, &reg_list,
2048                         &reg_list_size, REG_CLASS_ALL);
2049
2050         if (retval != ERROR_OK) {
2051                 LOG_ERROR("get register list failed");
2052                 return ERROR_FAIL;
2053         }
2054
2055         if (reg_list_size <= 0) {
2056                 free(reg_list);
2057                 return ERROR_FAIL;
2058         }
2059
2060         char **features = NULL;
2061         /* Get a list of available target registers features */
2062         retval = get_reg_features_list(target, &features, NULL, reg_list, reg_list_size);
2063         if (retval != ERROR_OK) {
2064                 LOG_ERROR("Can't get the registers feature list");
2065                 free(reg_list);
2066                 return ERROR_FAIL;
2067         }
2068
2069         /* If we found some features associated with registers, create sections */
2070         int current_feature = 0;
2071
2072         xml_printf(&retval, &tdesc, &pos, &size,
2073                         "<?xml version=\"1.0\"?>\n"
2074                         "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">\n"
2075                         "<target version=\"1.0\">\n");
2076
2077         /* generate target description according to register list */
2078         if (features != NULL) {
2079                 while (features[current_feature]) {
2080
2081                         xml_printf(&retval, &tdesc, &pos, &size,
2082                                         "<feature name=\"%s\">\n",
2083                                         features[current_feature]);
2084
2085                         int i;
2086                         for (i = 0; i < reg_list_size; i++) {
2087
2088                                 if (reg_list[i]->exist == false)
2089                                         continue;
2090
2091                                 if (strcmp(reg_list[i]->feature->name, features[current_feature]))
2092                                         continue;
2093
2094                                 const char *type_str;
2095                                 if (reg_list[i]->reg_data_type != NULL) {
2096                                         if (reg_list[i]->reg_data_type->type == REG_TYPE_ARCH_DEFINED) {
2097                                                 /* generate <type... first, if there are architecture-defined types. */
2098                                                 gdb_generate_reg_type_description(target, &tdesc, &pos, &size,
2099                                                                 reg_list[i]->reg_data_type);
2100
2101                                                 type_str = reg_list[i]->reg_data_type->id;
2102                                         } else {
2103                                                 /* predefined type */
2104                                                 type_str = gdb_get_reg_type_name(
2105                                                                 reg_list[i]->reg_data_type->type);
2106                                         }
2107                                 } else {
2108                                         /* Default type is "int" */
2109                                         type_str = "int";
2110                                 }
2111
2112                                 xml_printf(&retval, &tdesc, &pos, &size,
2113                                                 "<reg name=\"%s\"", reg_list[i]->name);
2114                                 xml_printf(&retval, &tdesc, &pos, &size,
2115                                                 " bitsize=\"%d\"", reg_list[i]->size);
2116                                 xml_printf(&retval, &tdesc, &pos, &size,
2117                                                 " regnum=\"%d\"", reg_list[i]->number);
2118                                 if (reg_list[i]->caller_save)
2119                                         xml_printf(&retval, &tdesc, &pos, &size,
2120                                                         " save-restore=\"yes\"");
2121                                 else
2122                                         xml_printf(&retval, &tdesc, &pos, &size,
2123                                                         " save-restore=\"no\"");
2124
2125                                 xml_printf(&retval, &tdesc, &pos, &size,
2126                                                 " type=\"%s\"", type_str);
2127
2128                                 if (reg_list[i]->group != NULL)
2129                                         xml_printf(&retval, &tdesc, &pos, &size,
2130                                                         " group=\"%s\"", reg_list[i]->group);
2131
2132                                 xml_printf(&retval, &tdesc, &pos, &size,
2133                                                 "/>\n");
2134                         }
2135
2136                         xml_printf(&retval, &tdesc, &pos, &size,
2137                                         "</feature>\n");
2138
2139                         current_feature++;
2140                 }
2141         }
2142
2143         xml_printf(&retval, &tdesc, &pos, &size,
2144                         "</target>\n");
2145
2146         free(reg_list);
2147         free(features);
2148
2149         if (retval == ERROR_OK)
2150                 *tdesc_out = tdesc;
2151         else
2152                 free(tdesc);
2153
2154         return retval;
2155 }
2156
2157 static int gdb_get_target_description_chunk(struct target *target, struct target_desc_format *target_desc,
2158                 char **chunk, int32_t offset, uint32_t length)
2159 {
2160         if (target_desc == NULL) {
2161                 LOG_ERROR("Unable to Generate Target Description");
2162                 return ERROR_FAIL;
2163         }
2164
2165         char *tdesc = target_desc->tdesc;
2166         uint32_t tdesc_length = target_desc->tdesc_length;
2167
2168         if (tdesc == NULL) {
2169                 int retval = gdb_generate_target_description(target, &tdesc);
2170                 if (retval != ERROR_OK) {
2171                         LOG_ERROR("Unable to Generate Target Description");
2172                         return ERROR_FAIL;
2173                 }
2174
2175                 tdesc_length = strlen(tdesc);
2176         }
2177
2178         char transfer_type;
2179
2180         if (length < (tdesc_length - offset))
2181                 transfer_type = 'm';
2182         else
2183                 transfer_type = 'l';
2184
2185         *chunk = malloc(length + 2);
2186         if (*chunk == NULL) {
2187                 LOG_ERROR("Unable to allocate memory");
2188                 return ERROR_FAIL;
2189         }
2190
2191         (*chunk)[0] = transfer_type;
2192         if (transfer_type == 'm') {
2193                 strncpy((*chunk) + 1, tdesc + offset, length);
2194                 (*chunk)[1 + length] = '\0';
2195         } else {
2196                 strncpy((*chunk) + 1, tdesc + offset, tdesc_length - offset);
2197                 (*chunk)[1 + (tdesc_length - offset)] = '\0';
2198
2199                 /* After gdb-server sends out last chunk, invalidate tdesc. */
2200                 free(tdesc);
2201                 tdesc = NULL;
2202                 tdesc_length = 0;
2203         }
2204
2205         target_desc->tdesc = tdesc;
2206         target_desc->tdesc_length = tdesc_length;
2207
2208         return ERROR_OK;
2209 }
2210
2211 static int gdb_target_description_supported(struct target *target, int *supported)
2212 {
2213         int retval = ERROR_OK;
2214         struct reg **reg_list = NULL;
2215         int reg_list_size = 0;
2216         int feature_list_size = 0;
2217         char **features = NULL;
2218
2219         retval = target_get_gdb_reg_list(target, &reg_list,
2220                         &reg_list_size, REG_CLASS_ALL);
2221         if (retval != ERROR_OK) {
2222                 LOG_ERROR("get register list failed");
2223                 goto error;
2224         }
2225
2226         if (reg_list_size <= 0) {
2227                 retval = ERROR_FAIL;
2228                 goto error;
2229         }
2230
2231         /* Get a list of available target registers features */
2232         retval = get_reg_features_list(target, &features, &feature_list_size, reg_list, reg_list_size);
2233         if (retval != ERROR_OK) {
2234                 LOG_ERROR("Can't get the registers feature list");
2235                 goto error;
2236         }
2237
2238         if (supported) {
2239                 if (feature_list_size)
2240                         *supported = 1;
2241                 else
2242                         *supported = 0;
2243         }
2244
2245 error:
2246         if (reg_list != NULL)
2247                 free(reg_list);
2248
2249         if (features != NULL)
2250                 free(features);
2251
2252         return retval;
2253 }
2254
2255 static int gdb_query_packet(struct connection *connection,
2256                 char *packet, int packet_size)
2257 {
2258         struct command_context *cmd_ctx = connection->cmd_ctx;
2259         struct gdb_connection *gdb_connection = connection->priv;
2260         struct target *target = get_target_from_connection(connection);
2261
2262         if (strncmp(packet, "qRcmd,", 6) == 0) {
2263                 if (packet_size > 6) {
2264                         char *cmd;
2265                         cmd = malloc((packet_size - 6) / 2 + 1);
2266                         int len = unhexify(cmd, packet + 6, (packet_size - 6) / 2);
2267                         cmd[len] = 0;
2268
2269                         /* We want to print all debug output to GDB connection */
2270                         log_add_callback(gdb_log_callback, connection);
2271                         target_call_timer_callbacks_now();
2272                         /* some commands need to know the GDB connection, make note of current
2273                          * GDB connection. */
2274                         current_gdb_connection = gdb_connection;
2275                         command_run_line(cmd_ctx, cmd);
2276                         current_gdb_connection = NULL;
2277                         target_call_timer_callbacks_now();
2278                         log_remove_callback(gdb_log_callback, connection);
2279                         free(cmd);
2280                 }
2281                 gdb_put_packet(connection, "OK", 2);
2282                 return ERROR_OK;
2283         } else if (strncmp(packet, "qCRC:", 5) == 0) {
2284                 if (packet_size > 5) {
2285                         int retval;
2286                         char gdb_reply[10];
2287                         char *separator;
2288                         uint32_t checksum;
2289                         uint32_t addr = 0;
2290                         uint32_t len = 0;
2291
2292                         /* skip command character */
2293                         packet += 5;
2294
2295                         addr = strtoul(packet, &separator, 16);
2296
2297                         if (*separator != ',') {
2298                                 LOG_ERROR("incomplete read memory packet received, dropping connection");
2299                                 return ERROR_SERVER_REMOTE_CLOSED;
2300                         }
2301
2302                         len = strtoul(separator + 1, NULL, 16);
2303
2304                         retval = target_checksum_memory(target, addr, len, &checksum);
2305
2306                         if (retval == ERROR_OK) {
2307                                 snprintf(gdb_reply, 10, "C%8.8" PRIx32 "", checksum);
2308                                 gdb_put_packet(connection, gdb_reply, 9);
2309                         } else {
2310                                 retval = gdb_error(connection, retval);
2311                                 if (retval != ERROR_OK)
2312                                         return retval;
2313                         }
2314
2315                         return ERROR_OK;
2316                 }
2317         } else if (strncmp(packet, "qSupported", 10) == 0) {
2318                 /* we currently support packet size and qXfer:memory-map:read (if enabled)
2319                  * qXfer:features:read is supported for some targets */
2320                 int retval = ERROR_OK;
2321                 char *buffer = NULL;
2322                 int pos = 0;
2323                 int size = 0;
2324                 int gdb_target_desc_supported = 0;
2325
2326                 /* we need to test that the target supports target descriptions */
2327                 retval = gdb_target_description_supported(target, &gdb_target_desc_supported);
2328                 if (retval != ERROR_OK) {
2329                         LOG_INFO("Failed detecting Target Description Support, disabling");
2330                         gdb_target_desc_supported = 0;
2331                 }
2332
2333                 /* support may be disabled globally */
2334                 if (gdb_use_target_description == 0) {
2335                         if (gdb_target_desc_supported)
2336                                 LOG_WARNING("Target Descriptions Supported, but disabled");
2337                         gdb_target_desc_supported = 0;
2338                 }
2339
2340                 xml_printf(&retval,
2341                         &buffer,
2342                         &pos,
2343                         &size,
2344                         "PacketSize=%x;qXfer:memory-map:read%c;qXfer:features:read%c;QStartNoAckMode+",
2345                         (GDB_BUFFER_SIZE - 1),
2346                         ((gdb_use_memory_map == 1) && (flash_get_bank_count() > 0)) ? '+' : '-',
2347                         (gdb_target_desc_supported == 1) ? '+' : '-');
2348
2349                 if (retval != ERROR_OK) {
2350                         gdb_send_error(connection, 01);
2351                         return ERROR_OK;
2352                 }
2353
2354                 gdb_put_packet(connection, buffer, strlen(buffer));
2355                 free(buffer);
2356
2357                 return ERROR_OK;
2358         } else if ((strncmp(packet, "qXfer:memory-map:read::", 23) == 0)
2359                    && (flash_get_bank_count() > 0))
2360                 return gdb_memory_map(connection, packet, packet_size);
2361         else if (strncmp(packet, "qXfer:features:read:", 20) == 0) {
2362                 char *xml = NULL;
2363                 int retval = ERROR_OK;
2364
2365                 int offset;
2366                 unsigned int length;
2367                 char *annex;
2368
2369                 /* skip command character */
2370                 packet += 20;
2371
2372                 if (decode_xfer_read(packet, &annex, &offset, &length) < 0) {
2373                         gdb_send_error(connection, 01);
2374                         return ERROR_OK;
2375                 }
2376
2377                 /* Target should prepare correct target description for annex.
2378                  * The first character of returned xml is 'm' or 'l'. 'm' for
2379                  * there are *more* chunks to transfer. 'l' for it is the *last*
2380                  * chunk of target description.
2381                  */
2382                 retval = gdb_get_target_description_chunk(target, &gdb_connection->target_desc,
2383                                 &xml, offset, length);
2384                 if (retval != ERROR_OK) {
2385                         gdb_error(connection, retval);
2386                         return retval;
2387                 }
2388
2389                 gdb_put_packet(connection, xml, strlen(xml));
2390
2391                 free(xml);
2392                 return ERROR_OK;
2393         } else if (strncmp(packet, "QStartNoAckMode", 15) == 0) {
2394                 gdb_connection->noack_mode = 1;
2395                 gdb_put_packet(connection, "OK", 2);
2396                 return ERROR_OK;
2397         }
2398
2399         gdb_put_packet(connection, "", 0);
2400         return ERROR_OK;
2401 }
2402
2403 static int gdb_v_packet(struct connection *connection,
2404                 char *packet, int packet_size)
2405 {
2406         struct gdb_connection *gdb_connection = connection->priv;
2407         struct gdb_service *gdb_service = connection->service->priv;
2408         int result;
2409
2410         /* if flash programming disabled - send a empty reply */
2411
2412         if (gdb_flash_program == 0) {
2413                 gdb_put_packet(connection, "", 0);
2414                 return ERROR_OK;
2415         }
2416
2417         if (strncmp(packet, "vFlashErase:", 12) == 0) {
2418                 unsigned long addr;
2419                 unsigned long length;
2420
2421                 char *parse = packet + 12;
2422                 if (*parse == '\0') {
2423                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2424                         return ERROR_SERVER_REMOTE_CLOSED;
2425                 }
2426
2427                 addr = strtoul(parse, &parse, 16);
2428
2429                 if (*(parse++) != ',' || *parse == '\0') {
2430                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2431                         return ERROR_SERVER_REMOTE_CLOSED;
2432                 }
2433
2434                 length = strtoul(parse, &parse, 16);
2435
2436                 if (*parse != '\0') {
2437                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2438                         return ERROR_SERVER_REMOTE_CLOSED;
2439                 }
2440
2441                 /* assume all sectors need erasing - stops any problems
2442                  * when flash_write is called multiple times */
2443                 flash_set_dirty();
2444
2445                 /* perform any target specific operations before the erase */
2446                 target_call_event_callbacks(gdb_service->target,
2447                         TARGET_EVENT_GDB_FLASH_ERASE_START);
2448
2449                 /* vFlashErase:addr,length messages require region start and
2450                  * end to be "block" aligned ... if padding is ever needed,
2451                  * GDB will have become dangerously confused.
2452                  */
2453                 result = flash_erase_address_range(gdb_service->target,
2454                                 false, addr, length);
2455
2456                 /* perform any target specific operations after the erase */
2457                 target_call_event_callbacks(gdb_service->target,
2458                         TARGET_EVENT_GDB_FLASH_ERASE_END);
2459
2460                 /* perform erase */
2461                 if (result != ERROR_OK) {
2462                         /* GDB doesn't evaluate the actual error number returned,
2463                          * treat a failed erase as an I/O error
2464                          */
2465                         gdb_send_error(connection, EIO);
2466                         LOG_ERROR("flash_erase returned %i", result);
2467                 } else
2468                         gdb_put_packet(connection, "OK", 2);
2469
2470                 return ERROR_OK;
2471         }
2472
2473         if (strncmp(packet, "vFlashWrite:", 12) == 0) {
2474                 int retval;
2475                 unsigned long addr;
2476                 unsigned long length;
2477                 char *parse = packet + 12;
2478
2479                 if (*parse == '\0') {
2480                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2481                         return ERROR_SERVER_REMOTE_CLOSED;
2482                 }
2483                 addr = strtoul(parse, &parse, 16);
2484                 if (*(parse++) != ':') {
2485                         LOG_ERROR("incomplete vFlashErase packet received, dropping connection");
2486                         return ERROR_SERVER_REMOTE_CLOSED;
2487                 }
2488                 length = packet_size - (parse - packet);
2489
2490                 /* create a new image if there isn't already one */
2491                 if (gdb_connection->vflash_image == NULL) {
2492                         gdb_connection->vflash_image = malloc(sizeof(struct image));
2493                         image_open(gdb_connection->vflash_image, "", "build");
2494                 }
2495
2496                 /* create new section with content from packet buffer */
2497                 retval = image_add_section(gdb_connection->vflash_image,
2498                                 addr, length, 0x0, (uint8_t *)parse);
2499                 if (retval != ERROR_OK)
2500                         return retval;
2501
2502                 gdb_put_packet(connection, "OK", 2);
2503
2504                 return ERROR_OK;
2505         }
2506
2507         if (strncmp(packet, "vFlashDone", 10) == 0) {
2508                 uint32_t written;
2509
2510                 /* process the flashing buffer. No need to erase as GDB
2511                  * always issues a vFlashErase first. */
2512                 target_call_event_callbacks(gdb_service->target,
2513                                 TARGET_EVENT_GDB_FLASH_WRITE_START);
2514                 result = flash_write(gdb_service->target, gdb_connection->vflash_image, &written, 0);
2515                 target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_FLASH_WRITE_END);
2516                 if (result != ERROR_OK) {
2517                         if (result == ERROR_FLASH_DST_OUT_OF_BANK)
2518                                 gdb_put_packet(connection, "E.memtype", 9);
2519                         else
2520                                 gdb_send_error(connection, EIO);
2521                 } else {
2522                         LOG_DEBUG("wrote %u bytes from vFlash image to flash", (unsigned)written);
2523                         gdb_put_packet(connection, "OK", 2);
2524                 }
2525
2526                 image_close(gdb_connection->vflash_image);
2527                 free(gdb_connection->vflash_image);
2528                 gdb_connection->vflash_image = NULL;
2529
2530                 return ERROR_OK;
2531         }
2532
2533         gdb_put_packet(connection, "", 0);
2534         return ERROR_OK;
2535 }
2536
2537 static int gdb_detach(struct connection *connection)
2538 {
2539         struct gdb_service *gdb_service = connection->service->priv;
2540
2541         target_call_event_callbacks(gdb_service->target, TARGET_EVENT_GDB_DETACH);
2542
2543         return gdb_put_packet(connection, "OK", 2);
2544 }
2545
2546 /* The format of 'F' response packet is
2547  * Fretcode,errno,Ctrl-C flag;call-specific attachment
2548  */
2549 static int gdb_fileio_response_packet(struct connection *connection,
2550                 char *packet, int packet_size)
2551 {
2552         struct target *target = get_target_from_connection(connection);
2553         char *separator;
2554         char *parsing_point;
2555         int fileio_retcode = strtoul(packet + 1, &separator, 16);
2556         int fileio_errno = 0;
2557         bool fileio_ctrl_c = false;
2558         int retval;
2559
2560         LOG_DEBUG("-");
2561
2562         if (*separator == ',') {
2563                 parsing_point = separator + 1;
2564                 fileio_errno = strtoul(parsing_point, &separator, 16);
2565                 if (*separator == ',') {
2566                         if (*(separator + 1) == 'C') {
2567                                 /* TODO: process ctrl-c */
2568                                 fileio_ctrl_c = true;
2569                         }
2570                 }
2571         }
2572
2573         LOG_DEBUG("File-I/O response, retcode: 0x%x, errno: 0x%x, ctrl-c: %s",
2574                         fileio_retcode, fileio_errno, fileio_ctrl_c ? "true" : "false");
2575
2576         retval = target_gdb_fileio_end(target, fileio_retcode, fileio_errno, fileio_ctrl_c);
2577         if (retval != ERROR_OK)
2578                 return ERROR_FAIL;
2579
2580         /* After File-I/O ends, keep continue or step */
2581         if (gdb_running_type == 'c')
2582                 retval = target_resume(target, 1, 0x0, 0, 0);
2583         else if (gdb_running_type == 's')
2584                 retval = target_step(target, 1, 0x0, 0);
2585         else
2586                 retval = ERROR_FAIL;
2587
2588         if (retval != ERROR_OK)
2589                 return ERROR_FAIL;
2590
2591         return ERROR_OK;
2592 }
2593
2594 static void gdb_log_callback(void *priv, const char *file, unsigned line,
2595                 const char *function, const char *string)
2596 {
2597         struct connection *connection = priv;
2598         struct gdb_connection *gdb_con = connection->priv;
2599
2600         if (gdb_con->busy) {
2601                 /* do not reply this using the O packet */
2602                 return;
2603         }
2604
2605         gdb_output_con(connection, string);
2606 }
2607
2608 static void gdb_sig_halted(struct connection *connection)
2609 {
2610         char sig_reply[4];
2611         snprintf(sig_reply, 4, "T%2.2x", 2);
2612         gdb_put_packet(connection, sig_reply, 3);
2613 }
2614
2615 static int gdb_input_inner(struct connection *connection)
2616 {
2617         /* Do not allocate this on the stack */
2618         static char gdb_packet_buffer[GDB_BUFFER_SIZE];
2619
2620         struct gdb_service *gdb_service = connection->service->priv;
2621         struct target *target = gdb_service->target;
2622         char *packet = gdb_packet_buffer;
2623         int packet_size;
2624         int retval;
2625         struct gdb_connection *gdb_con = connection->priv;
2626         static int extended_protocol;
2627
2628         /* drain input buffer. If one of the packets fail, then an error
2629          * packet is replied, if applicable.
2630          *
2631          * This loop will terminate and the error code is returned.
2632          *
2633          * The calling fn will check if this error is something that
2634          * can be recovered from, or if the connection must be closed.
2635          *
2636          * If the error is recoverable, this fn is called again to
2637          * drain the rest of the buffer.
2638          */
2639         do {
2640                 packet_size = GDB_BUFFER_SIZE-1;
2641                 retval = gdb_get_packet(connection, packet, &packet_size);
2642                 if (retval != ERROR_OK)
2643                         return retval;
2644
2645                 /* terminate with zero */
2646                 packet[packet_size] = 0;
2647
2648                 if (LOG_LEVEL_IS(LOG_LVL_DEBUG)) {
2649                         if (packet[0] == 'X') {
2650                                 /* binary packets spew junk into the debug log stream */
2651                                 char buf[50];
2652                                 int x;
2653                                 for (x = 0; (x < 49) && (packet[x] != ':'); x++)
2654                                         buf[x] = packet[x];
2655                                 buf[x] = 0;
2656                                 LOG_DEBUG("received packet: '%s:<binary-data>'", buf);
2657                         } else
2658                                 LOG_DEBUG("received packet: '%s'", packet);
2659                 }
2660
2661                 if (packet_size > 0) {
2662                         retval = ERROR_OK;
2663                         switch (packet[0]) {
2664                                 case 'T':       /* Is thread alive? */
2665                                         gdb_thread_packet(connection, packet, packet_size);
2666                                         break;
2667                                 case 'H':       /* Set current thread ( 'c' for step and continue,
2668                                                          * 'g' for all other operations ) */
2669                                         gdb_thread_packet(connection, packet, packet_size);
2670                                         break;
2671                                 case 'q':
2672                                 case 'Q':
2673                                         retval = gdb_thread_packet(connection, packet, packet_size);
2674                                         if (retval == GDB_THREAD_PACKET_NOT_CONSUMED)
2675                                                 retval = gdb_query_packet(connection, packet, packet_size);
2676                                         break;
2677                                 case 'g':
2678                                         retval = gdb_get_registers_packet(connection, packet, packet_size);
2679                                         break;
2680                                 case 'G':
2681                                         retval = gdb_set_registers_packet(connection, packet, packet_size);
2682                                         break;
2683                                 case 'p':
2684                                         retval = gdb_get_register_packet(connection, packet, packet_size);
2685                                         break;
2686                                 case 'P':
2687                                         retval = gdb_set_register_packet(connection, packet, packet_size);
2688                                         break;
2689                                 case 'm':
2690                                         retval = gdb_read_memory_packet(connection, packet, packet_size);
2691                                         break;
2692                                 case 'M':
2693                                         retval = gdb_write_memory_packet(connection, packet, packet_size);
2694                                         break;
2695                                 case 'z':
2696                                 case 'Z':
2697                                         retval = gdb_breakpoint_watchpoint_packet(connection, packet, packet_size);
2698                                         break;
2699                                 case '?':
2700                                         gdb_last_signal_packet(connection, packet, packet_size);
2701                                         break;
2702                                 case 'c':
2703                                 case 's':
2704                                 {
2705                                         gdb_thread_packet(connection, packet, packet_size);
2706                                         log_add_callback(gdb_log_callback, connection);
2707
2708                                         if (gdb_con->mem_write_error) {
2709                                                 LOG_ERROR("Memory write failure!");
2710
2711                                                 /* now that we have reported the memory write error,
2712                                                  * we can clear the condition */
2713                                                 gdb_con->mem_write_error = false;
2714                                         }
2715
2716                                         bool nostep = false;
2717                                         bool already_running = false;
2718                                         if (target->state == TARGET_RUNNING) {
2719                                                 LOG_WARNING("WARNING! The target is already running. "
2720                                                                 "All changes GDB did to registers will be discarded! "
2721                                                                 "Waiting for target to halt.");
2722                                                 already_running = true;
2723                                         } else if (target->state != TARGET_HALTED) {
2724                                                 LOG_WARNING("The target is not in the halted nor running stated, " \
2725                                                                 "stepi/continue ignored.");
2726                                                 nostep = true;
2727                                         } else if ((packet[0] == 's') && gdb_con->sync) {
2728                                                 /* Hmm..... when you issue a continue in GDB, then a "stepi" is
2729                                                  * sent by GDB first to OpenOCD, thus defeating the check to
2730                                                  * make only the single stepping have the sync feature...
2731                                                  */
2732                                                 nostep = true;
2733                                                 LOG_WARNING("stepi ignored. GDB will now fetch the register state " \
2734                                                                 "from the target.");
2735                                         }
2736                                         gdb_con->sync = false;
2737
2738                                         if (!already_running && nostep) {
2739                                                 /* Either the target isn't in the halted state, then we can't
2740                                                  * step/continue. This might be early setup, etc.
2741                                                  *
2742                                                  * Or we want to allow GDB to pick up a fresh set of
2743                                                  * register values without modifying the target state.
2744                                                  *
2745                                                  */
2746                                                 gdb_sig_halted(connection);
2747
2748                                                 /* stop forwarding log packets! */
2749                                                 log_remove_callback(gdb_log_callback, connection);
2750                                         } else {
2751                                                 /* We're running/stepping, in which case we can
2752                                                  * forward log output until the target is halted
2753                                                  */
2754                                                 gdb_con->frontend_state = TARGET_RUNNING;
2755                                                 target_call_event_callbacks(target, TARGET_EVENT_GDB_START);
2756
2757                                                 if (!already_running) {
2758                                                         /* Here we don't want packet processing to stop even if this fails,
2759                                                          * so we use a local variable instead of retval. */
2760                                                         retval = gdb_step_continue_packet(connection, packet, packet_size);
2761                                                         if (retval != ERROR_OK) {
2762                                                                 /* we'll never receive a halted
2763                                                                  * condition... issue a false one..
2764                                                                  */
2765                                                                 gdb_frontend_halted(target, connection);
2766                                                         }
2767                                                 }
2768                                         }
2769                                 }
2770                                 break;
2771                                 case 'v':
2772                                         retval = gdb_v_packet(connection, packet, packet_size);
2773                                         break;
2774                                 case 'D':
2775                                         retval = gdb_detach(connection);
2776                                         extended_protocol = 0;
2777                                         break;
2778                                 case 'X':
2779                                         retval = gdb_write_memory_binary_packet(connection, packet, packet_size);
2780                                         if (retval != ERROR_OK)
2781                                                 return retval;
2782                                         break;
2783                                 case 'k':
2784                                         if (extended_protocol != 0) {
2785                                                 gdb_con->attached = false;
2786                                                 break;
2787                                         }
2788                                         gdb_put_packet(connection, "OK", 2);
2789                                         return ERROR_SERVER_REMOTE_CLOSED;
2790                                 case '!':
2791                                         /* handle extended remote protocol */
2792                                         extended_protocol = 1;
2793                                         gdb_put_packet(connection, "OK", 2);
2794                                         break;
2795                                 case 'R':
2796                                         /* handle extended restart packet */
2797                                         breakpoint_clear_target(gdb_service->target);
2798                                         watchpoint_clear_target(gdb_service->target);
2799                                         command_run_linef(connection->cmd_ctx, "ocd_gdb_restart %s",
2800                                                         target_name(target));
2801                                         /* set connection as attached after reset */
2802                                         gdb_con->attached = true;
2803                                         /*  info rtos parts */
2804                                         gdb_thread_packet(connection, packet, packet_size);
2805                                         break;
2806
2807                                 case 'j':
2808                                         /* packet supported only by smp target i.e cortex_a.c*/
2809                                         /* handle smp packet replying coreid played to gbd */
2810                                         gdb_read_smp_packet(connection, packet, packet_size);
2811                                         break;
2812
2813                                 case 'J':
2814                                         /* packet supported only by smp target i.e cortex_a.c */
2815                                         /* handle smp packet setting coreid to be played at next
2816                                          * resume to gdb */
2817                                         gdb_write_smp_packet(connection, packet, packet_size);
2818                                         break;
2819
2820                                 case 'F':
2821                                         /* File-I/O extension */
2822                                         /* After gdb uses host-side syscall to complete target file
2823                                          * I/O, gdb sends host-side syscall return value to target
2824                                          * by 'F' packet.
2825                                          * The format of 'F' response packet is
2826                                          * Fretcode,errno,Ctrl-C flag;call-specific attachment
2827                                          */
2828                                         gdb_con->frontend_state = TARGET_RUNNING;
2829                                         log_add_callback(gdb_log_callback, connection);
2830                                         gdb_fileio_response_packet(connection, packet, packet_size);
2831                                         break;
2832
2833                                 default:
2834                                         /* ignore unknown packets */
2835                                         LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]);
2836                                         gdb_put_packet(connection, NULL, 0);
2837                                         break;
2838                         }
2839
2840                         /* if a packet handler returned an error, exit input loop */
2841                         if (retval != ERROR_OK)
2842                                 return retval;
2843                 }
2844
2845                 if (gdb_con->ctrl_c) {
2846                         if (target->state == TARGET_RUNNING) {
2847                                 retval = target_halt(target);
2848                                 if (retval != ERROR_OK)
2849                                         target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2850                                 gdb_con->ctrl_c = 0;
2851                         } else {
2852                                 LOG_INFO("The target is not running when halt was requested, stopping GDB.");
2853                                 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2854                         }
2855                 }
2856
2857         } while (gdb_con->buf_cnt > 0);
2858
2859         return ERROR_OK;
2860 }
2861
2862 static int gdb_input(struct connection *connection)
2863 {
2864         int retval = gdb_input_inner(connection);
2865         struct gdb_connection *gdb_con = connection->priv;
2866         if (retval == ERROR_SERVER_REMOTE_CLOSED)
2867                 return retval;
2868
2869         /* logging does not propagate the error, yet can set the gdb_con->closed flag */
2870         if (gdb_con->closed)
2871                 return ERROR_SERVER_REMOTE_CLOSED;
2872
2873         /* we'll recover from any other errors(e.g. temporary timeouts, etc.) */
2874         return ERROR_OK;
2875 }
2876
2877 static int gdb_target_start(struct target *target, const char *port)
2878 {
2879         struct gdb_service *gdb_service;
2880         int ret;
2881         gdb_service = malloc(sizeof(struct gdb_service));
2882
2883         if (NULL == gdb_service)
2884                 return -ENOMEM;
2885
2886         gdb_service->target = target;
2887         gdb_service->core[0] = -1;
2888         gdb_service->core[1] = -1;
2889         target->gdb_service = gdb_service;
2890
2891         ret = add_service("gdb",
2892                         port, 1, &gdb_new_connection, &gdb_input,
2893                         &gdb_connection_closed, gdb_service);
2894         /* initialialize all targets gdb service with the same pointer */
2895         {
2896                 struct target_list *head;
2897                 struct target *curr;
2898                 head = target->head;
2899                 while (head != (struct target_list *)NULL) {
2900                         curr = head->target;
2901                         if (curr != target)
2902                                 curr->gdb_service = gdb_service;
2903                         head = head->next;
2904                 }
2905         }
2906         return ret;
2907 }
2908
2909 static int gdb_target_add_one(struct target *target)
2910 {
2911         /*  one gdb instance per smp list */
2912         if ((target->smp) && (target->gdb_service))
2913                 return ERROR_OK;
2914         int retval = gdb_target_start(target, gdb_port_next);
2915         if (retval == ERROR_OK) {
2916                 long portnumber;
2917                 /* If we can parse the port number
2918                  * then we increment the port number for the next target.
2919                  */
2920                 char *end;
2921                 portnumber = strtol(gdb_port_next, &end, 0);
2922                 if (!*end) {
2923                         if (parse_long(gdb_port_next, &portnumber) == ERROR_OK) {
2924                                 free(gdb_port_next);
2925                                 gdb_port_next = alloc_printf("%d", portnumber+1);
2926                         }
2927                 }
2928         }
2929         return retval;
2930 }
2931
2932 int gdb_target_add_all(struct target *target)
2933 {
2934         if (NULL == target) {
2935                 LOG_WARNING("gdb services need one or more targets defined");
2936                 return ERROR_OK;
2937         }
2938
2939         while (NULL != target) {
2940                 int retval = gdb_target_add_one(target);
2941                 if (ERROR_OK != retval)
2942                         return retval;
2943
2944                 target = target->next;
2945         }
2946
2947         return ERROR_OK;
2948 }
2949
2950 COMMAND_HANDLER(handle_gdb_sync_command)
2951 {
2952         if (CMD_ARGC != 0)
2953                 return ERROR_COMMAND_SYNTAX_ERROR;
2954
2955         if (current_gdb_connection == NULL) {
2956                 command_print(CMD_CTX,
2957                         "gdb_sync command can only be run from within gdb using \"monitor gdb_sync\"");
2958                 return ERROR_FAIL;
2959         }
2960
2961         current_gdb_connection->sync = true;
2962
2963         return ERROR_OK;
2964 }
2965
2966 /* daemon configuration command gdb_port */
2967 COMMAND_HANDLER(handle_gdb_port_command)
2968 {
2969         int retval = CALL_COMMAND_HANDLER(server_pipe_command, &gdb_port);
2970         if (ERROR_OK == retval) {
2971                 free(gdb_port_next);
2972                 gdb_port_next = strdup(gdb_port);
2973         }
2974         return retval;
2975 }
2976
2977 COMMAND_HANDLER(handle_gdb_memory_map_command)
2978 {
2979         if (CMD_ARGC != 1)
2980                 return ERROR_COMMAND_SYNTAX_ERROR;
2981
2982         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_memory_map);
2983         return ERROR_OK;
2984 }
2985
2986 COMMAND_HANDLER(handle_gdb_flash_program_command)
2987 {
2988         if (CMD_ARGC != 1)
2989                 return ERROR_COMMAND_SYNTAX_ERROR;
2990
2991         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_flash_program);
2992         return ERROR_OK;
2993 }
2994
2995 COMMAND_HANDLER(handle_gdb_report_data_abort_command)
2996 {
2997         if (CMD_ARGC != 1)
2998                 return ERROR_COMMAND_SYNTAX_ERROR;
2999
3000         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_report_data_abort);
3001         return ERROR_OK;
3002 }
3003
3004 /* gdb_breakpoint_override */
3005 COMMAND_HANDLER(handle_gdb_breakpoint_override_command)
3006 {
3007         if (CMD_ARGC == 0) {
3008                 /* nothing */
3009         } else if (CMD_ARGC == 1) {
3010                 gdb_breakpoint_override = 1;
3011                 if (strcmp(CMD_ARGV[0], "hard") == 0)
3012                         gdb_breakpoint_override_type = BKPT_HARD;
3013                 else if (strcmp(CMD_ARGV[0], "soft") == 0)
3014                         gdb_breakpoint_override_type = BKPT_SOFT;
3015                 else if (strcmp(CMD_ARGV[0], "disable") == 0)
3016                         gdb_breakpoint_override = 0;
3017         } else
3018                 return ERROR_COMMAND_SYNTAX_ERROR;
3019         if (gdb_breakpoint_override)
3020                 LOG_USER("force %s breakpoints",
3021                         (gdb_breakpoint_override_type == BKPT_HARD) ? "hard" : "soft");
3022         else
3023                 LOG_USER("breakpoint type is not overridden");
3024
3025         return ERROR_OK;
3026 }
3027
3028 COMMAND_HANDLER(handle_gdb_target_description_command)
3029 {
3030         if (CMD_ARGC != 1)
3031                 return ERROR_COMMAND_SYNTAX_ERROR;
3032
3033         COMMAND_PARSE_ENABLE(CMD_ARGV[0], gdb_use_target_description);
3034         return ERROR_OK;
3035 }
3036
3037 COMMAND_HANDLER(handle_gdb_save_tdesc_command)
3038 {
3039         char *tdesc;
3040         uint32_t tdesc_length;
3041         struct target *target = get_current_target(CMD_CTX);
3042
3043         int retval = gdb_generate_target_description(target, &tdesc);
3044         if (retval != ERROR_OK) {
3045                 LOG_ERROR("Unable to Generate Target Description");
3046                 return ERROR_FAIL;
3047         }
3048
3049         tdesc_length = strlen(tdesc);
3050
3051         struct fileio fileio;
3052         size_t size_written;
3053
3054         char *tdesc_filename = alloc_printf("%s.xml", target_type_name(target));
3055         if (tdesc_filename == NULL) {
3056                 retval = ERROR_FAIL;
3057                 goto out;
3058         }
3059
3060         retval = fileio_open(&fileio, tdesc_filename, FILEIO_WRITE, FILEIO_TEXT);
3061
3062         if (retval != ERROR_OK) {
3063                 LOG_ERROR("Can't open %s for writing", tdesc_filename);
3064                 goto out;
3065         }
3066
3067         retval = fileio_write(&fileio, tdesc_length, tdesc, &size_written);
3068
3069         fileio_close(&fileio);
3070
3071         if (retval != ERROR_OK)
3072                 LOG_ERROR("Error while writing the tdesc file");
3073
3074 out:
3075         free(tdesc_filename);
3076         free(tdesc);
3077
3078         return retval;
3079 }
3080
3081 static const struct command_registration gdb_command_handlers[] = {
3082         {
3083                 .name = "gdb_sync",
3084                 .handler = handle_gdb_sync_command,
3085                 .mode = COMMAND_ANY,
3086                 .help = "next stepi will return immediately allowing "
3087                         "GDB to fetch register state without affecting "
3088                         "target state",
3089                 .usage = ""
3090         },
3091         {
3092                 .name = "gdb_port",
3093                 .handler = handle_gdb_port_command,
3094                 .mode = COMMAND_ANY,
3095                 .help = "Normally gdb listens to a TCP/IP port. Each subsequent GDB "
3096                         "server listens for the next port number after the "
3097                         "base port number specified. "
3098                         "No arguments reports GDB port. \"pipe\" means listen to stdin "
3099                         "output to stdout, an integer is base port number, \"disable\" disables "
3100                         "port. Any other string is are interpreted as named pipe to listen to. "
3101                         "Output pipe is the same name as input pipe, but with 'o' appended.",
3102                 .usage = "[port_num]",
3103         },
3104         {
3105                 .name = "gdb_memory_map",
3106                 .handler = handle_gdb_memory_map_command,
3107                 .mode = COMMAND_CONFIG,
3108                 .help = "enable or disable memory map",
3109                 .usage = "('enable'|'disable')"
3110         },
3111         {
3112                 .name = "gdb_flash_program",
3113                 .handler = handle_gdb_flash_program_command,
3114                 .mode = COMMAND_CONFIG,
3115                 .help = "enable or disable flash program",
3116                 .usage = "('enable'|'disable')"
3117         },
3118         {
3119                 .name = "gdb_report_data_abort",
3120                 .handler = handle_gdb_report_data_abort_command,
3121                 .mode = COMMAND_CONFIG,
3122                 .help = "enable or disable reporting data aborts",
3123                 .usage = "('enable'|'disable')"
3124         },
3125         {
3126                 .name = "gdb_breakpoint_override",
3127                 .handler = handle_gdb_breakpoint_override_command,
3128                 .mode = COMMAND_ANY,
3129                 .help = "Display or specify type of breakpoint "
3130                         "to be used by gdb 'break' commands.",
3131                 .usage = "('hard'|'soft'|'disable')"
3132         },
3133         {
3134                 .name = "gdb_target_description",
3135                 .handler = handle_gdb_target_description_command,
3136                 .mode = COMMAND_CONFIG,
3137                 .help = "enable or disable target description",
3138                 .usage = "('enable'|'disable')"
3139         },
3140         {
3141                 .name = "gdb_save_tdesc",
3142                 .handler = handle_gdb_save_tdesc_command,
3143                 .mode = COMMAND_EXEC,
3144                 .help = "Save the target description file",
3145         },
3146         COMMAND_REGISTRATION_DONE
3147 };
3148
3149 int gdb_register_commands(struct command_context *cmd_ctx)
3150 {
3151         gdb_port = strdup("3333");
3152         gdb_port_next = strdup("3333");
3153         return register_commands(cmd_ctx, NULL, gdb_command_handlers);
3154 }