gdb/gdbserver/regcache.c

   1 /* Register support routines for the remote server for GDB.
   2    Copyright (C) 2001-2017 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "server.h"
  20 #include "regdef.h"
  21 #include "gdbthread.h"
  22 #include "tdesc.h"
  23 #include "rsp-low.h"
  24 #ifndef IN_PROCESS_AGENT
  25
  26 struct regcache *
  27 get_thread_regcache (struct thread_info *thread, int fetch)
  28 {
  29   struct regcache *regcache;
  30
  31   regcache = thread_regcache_data (thread);
  32
  33   /* Threads' regcaches are created lazily, because biarch targets add
  34      the main thread/lwp before seeing it stop for the first time, and
  35      it is only after the target sees the thread stop for the first
  36      time that the target has a chance of determining the process's
  37      architecture.  IOW, when we first add the process's main thread
  38      we don't know which architecture/tdesc its regcache should
  39      have.  */
  40   if (regcache == NULL)
  41     {
  42       struct process_info *proc = get_thread_process (thread);
  43
  44       gdb_assert (proc->tdesc != NULL);
  45
  46       regcache = new_register_cache (proc->tdesc);
  47       set_thread_regcache_data (thread, regcache);
  48     }
  49
  50   if (fetch && regcache->registers_valid == 0)
  51     {
  52       struct thread_info *saved_thread = current_thread;
  53
  54       current_thread = thread;
  55       /* Invalidate all registers, to prevent stale left-overs.  */
  56       if (!VEC_empty (tdesc_reg_p, regcache->tdesc->reg_defs))
  57         memset (regcache->register_status, REG_UNAVAILABLE,
  58                 VEC_length (tdesc_reg_p, regcache->tdesc->reg_defs));
  59       fetch_inferior_registers (regcache, -1);
  60       current_thread = saved_thread;
  61       regcache->registers_valid = 1;
  62     }
  63
  64   return regcache;
  65 }
  66
  67 /* See common/common-regcache.h.  */
  68
  69 struct regcache *
  70 get_thread_regcache_for_ptid (ptid_t ptid)
  71 {
  72   return get_thread_regcache (find_thread_ptid (ptid), 1);
  73 }
  74
  75 void
  76 regcache_invalidate_thread (struct thread_info *thread)
  77 {
  78   struct regcache *regcache;
  79
  80   regcache = thread_regcache_data (thread);
  81
  82   if (regcache == NULL)
  83     return;
  84
  85   if (regcache->registers_valid)
  86     {
  87       struct thread_info *saved_thread = current_thread;
  88
  89       current_thread = thread;
  90       store_inferior_registers (regcache, -1);
  91       current_thread = saved_thread;
  92     }
  93
  94   regcache->registers_valid = 0;
  95 }
  96
  97 static int
  98 regcache_invalidate_one (struct inferior_list_entry *entry,
  99                          void *pid_p)
 100 {
 101   struct thread_info *thread = (struct thread_info *) entry;
 102   int pid = *(int *) pid_p;
 103
 104   /* Only invalidate the regcaches of threads of this process.  */
 105   if (ptid_get_pid (entry->id) == pid)
 106     regcache_invalidate_thread (thread);
 107
 108   return 0;
 109 }
 110
 111 /* See regcache.h.  */
 112
 113 void
 114 regcache_invalidate_pid (int pid)
 115 {
 116   find_inferior (&all_threads, regcache_invalidate_one, &pid);
 117 }
 118
 119 /* See regcache.h.  */
 120
 121 void
 122 regcache_invalidate (void)
 123 {
 124   /* Only update the threads of the current process.  */
 125   int pid = ptid_get_pid (current_thread->entry.id);
 126
 127   regcache_invalidate_pid (pid);
 128 }
 129
 130 #endif
 131
 132 struct regcache *
 133 init_register_cache (struct regcache *regcache,
 134                      const struct target_desc *tdesc,
 135                      unsigned char *regbuf)
 136 {
 137   if (regbuf == NULL)
 138     {
 139 #ifndef IN_PROCESS_AGENT
 140       /* Make sure to zero-initialize the register cache when it is
 141          created, in case there are registers the target never
 142          fetches.  This way they'll read as zero instead of
 143          garbage.  */
 144       regcache->tdesc = tdesc;
 145       regcache->registers
 146         = (unsigned char *) xcalloc (1, tdesc->registers_size);
 147       regcache->registers_owned = 1;
 148       regcache->register_status
 149         = (unsigned char *) xmalloc (VEC_length (tdesc_reg_p, tdesc->reg_defs));
 150       if (!VEC_empty (tdesc_reg_p, tdesc->reg_defs))
 151         memset ((void *) regcache->register_status, REG_UNAVAILABLE,
 152                 VEC_length (tdesc_reg_p, tdesc->reg_defs));
 153 #else
 154       gdb_assert_not_reached ("can't allocate memory from the heap");
 155 #endif
 156     }
 157   else
 158     {
 159       regcache->tdesc = tdesc;
 160       regcache->registers = regbuf;
 161       regcache->registers_owned = 0;
 162 #ifndef IN_PROCESS_AGENT
 163       regcache->register_status = NULL;
 164 #endif
 165     }
 166
 167   regcache->registers_valid = 0;
 168
 169   return regcache;
 170 }
 171
 172 #ifndef IN_PROCESS_AGENT
 173
 174 struct regcache *
 175 new_register_cache (const struct target_desc *tdesc)
 176 {
 177   struct regcache *regcache = XCNEW (struct regcache);
 178
 179   gdb_assert (tdesc->registers_size != 0);
 180
 181   return init_register_cache (regcache, tdesc, NULL);
 182 }
 183
 184 void
 185 free_register_cache (struct regcache *regcache)
 186 {
 187   if (regcache)
 188     {
 189       if (regcache->registers_owned)
 190         free (regcache->registers);
 191       free (regcache->register_status);
 192       free (regcache);
 193     }
 194 }
 195
 196 #endif
 197
 198 void
 199 regcache_cpy (struct regcache *dst, struct regcache *src)
 200 {
 201   gdb_assert (src != NULL && dst != NULL);
 202   gdb_assert (src->tdesc == dst->tdesc);
 203   gdb_assert (src != dst);
 204
 205   memcpy (dst->registers, src->registers, src->tdesc->registers_size);
 206 #ifndef IN_PROCESS_AGENT
 207   if (dst->register_status != NULL && src->register_status != NULL)
 208     memcpy (dst->register_status, src->register_status,
 209             VEC_length (tdesc_reg_p, src->tdesc->reg_defs));
 210 #endif
 211   dst->registers_valid = src->registers_valid;
 212 }
 213
 214
 215 #ifndef IN_PROCESS_AGENT
 216
 217 void
 218 registers_to_string (struct regcache *regcache, char *buf)
 219 {
 220   unsigned char *registers = regcache->registers;
 221   const struct target_desc *tdesc = regcache->tdesc;
 222   int i;
 223   reg *reg;
 224
 225   for (i = 0; VEC_iterate (tdesc_reg_p, tdesc->reg_defs, i, reg); i++)
 226     {
 227       if (regcache->register_status[i] == REG_VALID)
 228         {
 229           bin2hex (registers, buf, register_size (tdesc, i));
 230           buf += register_size (tdesc, i) * 2;
 231         }
 232       else
 233         {
 234           memset (buf, 'x', register_size (tdesc, i) * 2);
 235           buf += register_size (tdesc, i) * 2;
 236         }
 237       registers += register_size (tdesc, i);
 238     }
 239   *buf = '\0';
 240 }
 241
 242 void
 243 registers_from_string (struct regcache *regcache, char *buf)
 244 {
 245   int len = strlen (buf);
 246   unsigned char *registers = regcache->registers;
 247   const struct target_desc *tdesc = regcache->tdesc;
 248
 249   if (len != tdesc->registers_size * 2)
 250     {
 251       warning ("Wrong sized register packet (expected %d bytes, got %d)",
 252                2 * tdesc->registers_size, len);
 253       if (len > tdesc->registers_size * 2)
 254         len = tdesc->registers_size * 2;
 255     }
 256   hex2bin (buf, registers, len / 2);
 257 }
 258
 259 int
 260 find_regno (const struct target_desc *tdesc, const char *name)
 261 {
 262   int i;
 263   reg *reg;
 264
 265   for (i = 0; VEC_iterate (tdesc_reg_p, tdesc->reg_defs, i, reg); i++)
 266     if (strcmp (name, reg->name) == 0)
 267       return i;
 268   internal_error (__FILE__, __LINE__, "Unknown register %s requested",
 269                   name);
 270 }
 271
 272 #endif
 273
 274 struct reg *
 275 find_register_by_number (const struct target_desc *tdesc, int n)
 276 {
 277   return VEC_index (tdesc_reg_p, tdesc->reg_defs, n);
 278 }
 279
 280 #ifndef IN_PROCESS_AGENT
 281 static void
 282 free_register_cache_thread (struct thread_info *thread)
 283 {
 284   struct regcache *regcache = thread_regcache_data (thread);
 285
 286   if (regcache != NULL)
 287     {
 288       regcache_invalidate_thread (thread);
 289       free_register_cache (regcache);
 290       set_thread_regcache_data (thread, NULL);
 291     }
 292 }
 293
 294 static void
 295 free_register_cache_thread_one (struct inferior_list_entry *entry)
 296 {
 297   struct thread_info *thread = (struct thread_info *) entry;
 298
 299   free_register_cache_thread (thread);
 300 }
 301
 302 void
 303 regcache_release (void)
 304 {
 305   /* Flush and release all pre-existing register caches.  */
 306   for_each_inferior (&all_threads, free_register_cache_thread_one);
 307 }
 308 #endif
 309
 310 int
 311 register_cache_size (const struct target_desc *tdesc)
 312 {
 313   return tdesc->registers_size;
 314 }
 315
 316 int
 317 register_size (const struct target_desc *tdesc, int n)
 318 {
 319   return find_register_by_number (tdesc, n)->size / 8;
 320 }
 321
 322 /* See common/common-regcache.h.  */
 323
 324 int
 325 regcache_register_size (const struct regcache *regcache, int n)
 326 {
 327   return register_size (regcache->tdesc, n);
 328 }
 329
 330 static unsigned char *
 331 register_data (struct regcache *regcache, int n, int fetch)
 332 {
 333   return (regcache->registers
 334           + find_register_by_number (regcache->tdesc, n)->offset / 8);
 335 }
 336
 337 /* Supply register N, whose contents are stored in BUF, to REGCACHE.
 338    If BUF is NULL, the register's value is recorded as
 339    unavailable.  */
 340
 341 void
 342 supply_register (struct regcache *regcache, int n, const void *buf)
 343 {
 344   if (buf)
 345     {
 346       memcpy (register_data (regcache, n, 0), buf,
 347               register_size (regcache->tdesc, n));
 348 #ifndef IN_PROCESS_AGENT
 349       if (regcache->register_status != NULL)
 350         regcache->register_status[n] = REG_VALID;
 351 #endif
 352     }
 353   else
 354     {
 355       memset (register_data (regcache, n, 0), 0,
 356               register_size (regcache->tdesc, n));
 357 #ifndef IN_PROCESS_AGENT
 358       if (regcache->register_status != NULL)
 359         regcache->register_status[n] = REG_UNAVAILABLE;
 360 #endif
 361     }
 362 }
 363
 364 /* Supply register N with value zero to REGCACHE.  */
 365
 366 void
 367 supply_register_zeroed (struct regcache *regcache, int n)
 368 {
 369   memset (register_data (regcache, n, 0), 0,
 370           register_size (regcache->tdesc, n));
 371 #ifndef IN_PROCESS_AGENT
 372   if (regcache->register_status != NULL)
 373     regcache->register_status[n] = REG_VALID;
 374 #endif
 375 }
 376
 377 /* Supply the whole register set whose contents are stored in BUF, to
 378    REGCACHE.  If BUF is NULL, all the registers' values are recorded
 379    as unavailable.  */
 380
 381 void
 382 supply_regblock (struct regcache *regcache, const void *buf)
 383 {
 384   if (buf)
 385     {
 386       const struct target_desc *tdesc = regcache->tdesc;
 387
 388       memcpy (regcache->registers, buf, tdesc->registers_size);
 389 #ifndef IN_PROCESS_AGENT
 390       {
 391         int i;
 392
 393         for (i = 0; i < VEC_length (tdesc_reg_p, tdesc->reg_defs); i++)
 394           regcache->register_status[i] = REG_VALID;
 395       }
 396 #endif
 397     }
 398   else
 399     {
 400       const struct target_desc *tdesc = regcache->tdesc;
 401
 402       memset (regcache->registers, 0, tdesc->registers_size);
 403 #ifndef IN_PROCESS_AGENT
 404       {
 405         int i;
 406
 407         for (i = 0; i < VEC_length (tdesc_reg_p, tdesc->reg_defs); i++)
 408           regcache->register_status[i] = REG_UNAVAILABLE;
 409       }
 410 #endif
 411     }
 412 }
 413
 414 #ifndef IN_PROCESS_AGENT
 415
 416 void
 417 supply_register_by_name (struct regcache *regcache,
 418                          const char *name, const void *buf)
 419 {
 420   supply_register (regcache, find_regno (regcache->tdesc, name), buf);
 421 }
 422
 423 #endif
 424
 425 void
 426 collect_register (struct regcache *regcache, int n, void *buf)
 427 {
 428   memcpy (buf, register_data (regcache, n, 1),
 429           register_size (regcache->tdesc, n));
 430 }
 431
 432 enum register_status
 433 regcache_raw_read_unsigned (struct regcache *regcache, int regnum,
 434                             ULONGEST *val)
 435 {
 436   int size;
 437
 438   gdb_assert (regcache != NULL);
 439   gdb_assert (regnum >= 0
 440               && regnum < VEC_length (tdesc_reg_p, regcache->tdesc->reg_defs));
 441
 442   size = register_size (regcache->tdesc, regnum);
 443
 444   if (size > (int) sizeof (ULONGEST))
 445     error (_("That operation is not available on integers of more than"
 446             "%d bytes."),
 447           (int) sizeof (ULONGEST));
 448
 449   *val = 0;
 450   collect_register (regcache, regnum, val);
 451
 452   return REG_VALID;
 453 }
 454
 455 #ifndef IN_PROCESS_AGENT
 456
 457 void
 458 collect_register_as_string (struct regcache *regcache, int n, char *buf)
 459 {
 460   bin2hex (register_data (regcache, n, 1), buf,
 461            register_size (regcache->tdesc, n));
 462 }
 463
 464 void
 465 collect_register_by_name (struct regcache *regcache,
 466                           const char *name, void *buf)
 467 {
 468   collect_register (regcache, find_regno (regcache->tdesc, name), buf);
 469 }
 470
 471 /* Special handling for register PC.  */
 472
 473 CORE_ADDR
 474 regcache_read_pc (struct regcache *regcache)
 475 {
 476   CORE_ADDR pc_val;
 477
 478   if (the_target->read_pc)
 479     pc_val = the_target->read_pc (regcache);
 480   else
 481     internal_error (__FILE__, __LINE__,
 482                     "regcache_read_pc: Unable to find PC");
 483
 484   return pc_val;
 485 }
 486
 487 void
 488 regcache_write_pc (struct regcache *regcache, CORE_ADDR pc)
 489 {
 490   if (the_target->write_pc)
 491     the_target->write_pc (regcache, pc);
 492   else
 493     internal_error (__FILE__, __LINE__,
 494                     "regcache_write_pc: Unable to update PC");
 495 }
 496
 497 #endif