1 /* Memory attributes support, for GDB.
3 Copyright (C) 2001-2012 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "gdb_string.h"
29 #include "breakpoint.h"
30 #include "cli/cli-utils.h"
32 const struct mem_attrib default_mem_attrib =
35 MEM_WIDTH_UNSPECIFIED,
39 -1 /* Flash blocksize not specified. */
42 const struct mem_attrib unknown_mem_attrib =
45 MEM_WIDTH_UNSPECIFIED,
49 -1 /* Flash blocksize not specified. */
53 VEC(mem_region_s) *mem_region_list, *target_mem_region_list;
54 static int mem_number = 0;
56 /* If this flag is set, the memory region list should be automatically
57 updated from the target. If it is clear, the list is user-controlled
58 and should be left alone. */
59 static int mem_use_target = 1;
61 /* If this flag is set, we have tried to fetch the target memory regions
62 since the last time it was invalidated. If that list is still
63 empty, then the target can't supply memory regions. */
64 static int target_mem_regions_valid;
66 /* If this flag is set, gdb will assume that memory ranges not
67 specified by the memory map have type MEM_NONE, and will
68 emit errors on all accesses to that memory. */
69 static int inaccessible_by_default = 1;
72 show_inaccessible_by_default (struct ui_file *file, int from_tty,
73 struct cmd_list_element *c,
76 if (inaccessible_by_default)
77 fprintf_filtered (file, _("Unknown memory addresses will "
78 "be treated as inaccessible.\n"));
80 fprintf_filtered (file, _("Unknown memory addresses "
81 "will be treated as RAM.\n"));
85 /* Predicate function which returns true if LHS should sort before RHS
86 in a list of memory regions, useful for VEC_lower_bound. */
89 mem_region_lessthan (const struct mem_region *lhs,
90 const struct mem_region *rhs)
92 return lhs->lo < rhs->lo;
95 /* A helper function suitable for qsort, used to sort a
96 VEC(mem_region_s) by starting address. */
99 mem_region_cmp (const void *untyped_lhs, const void *untyped_rhs)
101 const struct mem_region *lhs = untyped_lhs;
102 const struct mem_region *rhs = untyped_rhs;
104 if (lhs->lo < rhs->lo)
106 else if (lhs->lo == rhs->lo)
112 /* Allocate a new memory region, with default settings. */
115 mem_region_init (struct mem_region *new)
117 memset (new, 0, sizeof (struct mem_region));
119 new->attrib = default_mem_attrib;
122 /* This function should be called before any command which would
123 modify the memory region list. It will handle switching from
124 a target-provided list to a local list, if necessary. */
127 require_user_regions (int from_tty)
129 struct mem_region *m;
132 /* If we're already using a user-provided list, nothing to do. */
136 /* Switch to a user-provided list (possibly a copy of the current
140 /* If we don't have a target-provided region list yet, then
142 if (mem_region_list == NULL)
145 /* Otherwise, let the user know how to get back. */
147 warning (_("Switching to manual control of memory regions; use "
148 "\"mem auto\" to fetch regions from the target again."));
150 /* And create a new list for the user to modify. */
151 length = VEC_length (mem_region_s, target_mem_region_list);
152 mem_region_list = VEC_alloc (mem_region_s, length);
153 for (ix = 0; VEC_iterate (mem_region_s, target_mem_region_list, ix, m); ix++)
154 VEC_quick_push (mem_region_s, mem_region_list, m);
157 /* This function should be called before any command which would
158 read the memory region list, other than those which call
159 require_user_regions. It will handle fetching the
160 target-provided list, if necessary. */
163 require_target_regions (void)
165 if (mem_use_target && !target_mem_regions_valid)
167 target_mem_regions_valid = 1;
168 target_mem_region_list = target_memory_map ();
169 mem_region_list = target_mem_region_list;
174 create_mem_region (CORE_ADDR lo, CORE_ADDR hi,
175 const struct mem_attrib *attrib)
177 struct mem_region new;
180 /* lo == hi is a useless empty region. */
181 if (lo >= hi && hi != 0)
183 printf_unfiltered (_("invalid memory region: low >= high\n"));
187 mem_region_init (&new);
191 ix = VEC_lower_bound (mem_region_s, mem_region_list, &new,
192 mem_region_lessthan);
194 /* Check for an overlapping memory region. We only need to check
195 in the vicinity - at most one before and one after the
197 for (i = ix - 1; i < ix + 1; i++)
199 struct mem_region *n;
203 if (i >= VEC_length (mem_region_s, mem_region_list))
206 n = VEC_index (mem_region_s, mem_region_list, i);
208 if ((lo >= n->lo && (lo < n->hi || n->hi == 0))
209 || (hi > n->lo && (hi <= n->hi || n->hi == 0))
210 || (lo <= n->lo && (hi >= n->hi || hi == 0)))
212 printf_unfiltered (_("overlapping memory region\n"));
217 new.number = ++mem_number;
218 new.attrib = *attrib;
219 VEC_safe_insert (mem_region_s, mem_region_list, ix, &new);
223 * Look up the memory region cooresponding to ADDR.
226 lookup_mem_region (CORE_ADDR addr)
228 static struct mem_region region;
229 struct mem_region *m;
234 require_target_regions ();
236 /* First we initialize LO and HI so that they describe the entire
237 memory space. As we process the memory region chain, they are
238 redefined to describe the minimal region containing ADDR. LO
239 and HI are used in the case where no memory region is defined
240 that contains ADDR. If a memory region is disabled, it is
241 treated as if it does not exist. The initial values for LO
242 and HI represent the bottom and top of memory. */
247 /* Either find memory range containing ADDRESS, or set LO and HI
248 to the nearest boundaries of an existing memory range.
250 If we ever want to support a huge list of memory regions, this
251 check should be replaced with a binary search (probably using
253 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
255 if (m->enabled_p == 1)
257 /* If the address is in the memory region, return that
259 if (addr >= m->lo && (addr < m->hi || m->hi == 0))
262 /* This (correctly) won't match if m->hi == 0, representing
263 the top of the address space, because CORE_ADDR is unsigned;
264 no value of LO is less than zero. */
265 if (addr >= m->hi && lo < m->hi)
268 /* This will never set HI to zero; if we're here and ADDR
269 is at or below M, and the region starts at zero, then ADDR
270 would have been in the region. */
271 if (addr <= m->lo && (hi == 0 || hi > m->lo))
276 /* Because no region was found, we must cons up one based on what
277 was learned above. */
281 /* When no memory map is defined at all, we always return
282 'default_mem_attrib', so that we do not make all memory
283 inaccessible for targets that don't provide a memory map. */
284 if (inaccessible_by_default && !VEC_empty (mem_region_s, mem_region_list))
285 region.attrib = unknown_mem_attrib;
287 region.attrib = default_mem_attrib;
292 /* Invalidate any memory regions fetched from the target. */
295 invalidate_target_mem_regions (void)
297 if (!target_mem_regions_valid)
300 target_mem_regions_valid = 0;
301 VEC_free (mem_region_s, target_mem_region_list);
303 mem_region_list = NULL;
306 /* Clear memory region list. */
311 VEC_free (mem_region_s, mem_region_list);
316 mem_command (char *args, int from_tty)
320 struct mem_attrib attrib;
323 error_no_arg (_("No mem"));
325 /* For "mem auto", switch back to using a target provided list. */
326 if (strcmp (args, "auto") == 0)
331 if (mem_region_list != target_mem_region_list)
334 mem_region_list = target_mem_region_list;
341 require_user_regions (from_tty);
343 tok = strtok (args, " \t");
345 error (_("no lo address"));
346 lo = parse_and_eval_address (tok);
348 tok = strtok (NULL, " \t");
350 error (_("no hi address"));
351 hi = parse_and_eval_address (tok);
353 attrib = default_mem_attrib;
354 while ((tok = strtok (NULL, " \t")) != NULL)
356 if (strcmp (tok, "rw") == 0)
357 attrib.mode = MEM_RW;
358 else if (strcmp (tok, "ro") == 0)
359 attrib.mode = MEM_RO;
360 else if (strcmp (tok, "wo") == 0)
361 attrib.mode = MEM_WO;
363 else if (strcmp (tok, "8") == 0)
364 attrib.width = MEM_WIDTH_8;
365 else if (strcmp (tok, "16") == 0)
367 if ((lo % 2 != 0) || (hi % 2 != 0))
368 error (_("region bounds not 16 bit aligned"));
369 attrib.width = MEM_WIDTH_16;
371 else if (strcmp (tok, "32") == 0)
373 if ((lo % 4 != 0) || (hi % 4 != 0))
374 error (_("region bounds not 32 bit aligned"));
375 attrib.width = MEM_WIDTH_32;
377 else if (strcmp (tok, "64") == 0)
379 if ((lo % 8 != 0) || (hi % 8 != 0))
380 error (_("region bounds not 64 bit aligned"));
381 attrib.width = MEM_WIDTH_64;
385 else if (strcmp (tok, "hwbreak") == 0)
387 else if (strcmp (tok, "swbreak") == 0)
391 else if (strcmp (tok, "cache") == 0)
393 else if (strcmp (tok, "nocache") == 0)
397 else if (strcmp (tok, "verify") == 0)
399 else if (strcmp (tok, "noverify") == 0)
404 error (_("unknown attribute: %s"), tok);
407 create_mem_region (lo, hi, &attrib);
412 mem_info_command (char *args, int from_tty)
414 struct mem_region *m;
415 struct mem_attrib *attrib;
419 printf_filtered (_("Using memory regions provided by the target.\n"));
421 printf_filtered (_("Using user-defined memory regions.\n"));
423 require_target_regions ();
425 if (!mem_region_list)
427 printf_unfiltered (_("There are no memory regions defined.\n"));
431 printf_filtered ("Num ");
432 printf_filtered ("Enb ");
433 printf_filtered ("Low Addr ");
434 if (gdbarch_addr_bit (target_gdbarch) > 32)
435 printf_filtered (" ");
436 printf_filtered ("High Addr ");
437 if (gdbarch_addr_bit (target_gdbarch) > 32)
438 printf_filtered (" ");
439 printf_filtered ("Attrs ");
440 printf_filtered ("\n");
442 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
446 printf_filtered ("%-3d %-3c\t",
448 m->enabled_p ? 'y' : 'n');
449 if (gdbarch_addr_bit (target_gdbarch) <= 32)
450 tmp = hex_string_custom ((unsigned long) m->lo, 8);
452 tmp = hex_string_custom ((unsigned long) m->lo, 16);
454 printf_filtered ("%s ", tmp);
456 if (gdbarch_addr_bit (target_gdbarch) <= 32)
461 tmp = hex_string_custom ((unsigned long) m->hi, 8);
466 tmp = "0x10000000000000000";
468 tmp = hex_string_custom ((unsigned long) m->hi, 16);
471 printf_filtered ("%s ", tmp);
473 /* Print a token for each attribute.
475 * FIXME: Should we output a comma after each token? It may
476 * make it easier for users to read, but we'd lose the ability
477 * to cut-and-paste the list of attributes when defining a new
478 * region. Perhaps that is not important.
480 * FIXME: If more attributes are added to GDB, the output may
481 * become cluttered and difficult for users to read. At that
482 * time, we may want to consider printing tokens only if they
483 * are different from the default attribute. */
486 switch (attrib->mode)
489 printf_filtered ("rw ");
492 printf_filtered ("ro ");
495 printf_filtered ("wo ");
498 printf_filtered ("flash blocksize 0x%x ", attrib->blocksize);
502 switch (attrib->width)
505 printf_filtered ("8 ");
508 printf_filtered ("16 ");
511 printf_filtered ("32 ");
514 printf_filtered ("64 ");
516 case MEM_WIDTH_UNSPECIFIED:
522 printf_filtered ("hwbreak");
524 printf_filtered ("swbreak");
528 printf_filtered ("cache ");
530 printf_filtered ("nocache ");
534 printf_filtered ("verify ");
536 printf_filtered ("noverify ");
539 printf_filtered ("\n");
541 gdb_flush (gdb_stdout);
546 /* Enable the memory region number NUM. */
551 struct mem_region *m;
554 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
555 if (m->number == num)
560 printf_unfiltered (_("No memory region number %d.\n"), num);
564 mem_enable_command (char *args, int from_tty)
567 struct mem_region *m;
570 require_user_regions (from_tty);
572 target_dcache_invalidate ();
574 if (args == NULL || *args == '\0')
575 { /* Enable all mem regions. */
576 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
581 struct get_number_or_range_state state;
583 init_number_or_range (&state, args);
584 while (!state.finished)
586 num = get_number_or_range (&state);
593 /* Disable the memory region number NUM. */
596 mem_disable (int num)
598 struct mem_region *m;
601 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
602 if (m->number == num)
607 printf_unfiltered (_("No memory region number %d.\n"), num);
611 mem_disable_command (char *args, int from_tty)
614 struct mem_region *m;
617 require_user_regions (from_tty);
619 target_dcache_invalidate ();
621 if (args == NULL || *args == '\0')
623 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
628 struct get_number_or_range_state state;
630 init_number_or_range (&state, args);
631 while (!state.finished)
633 num = get_number_or_range (&state);
639 /* Delete the memory region number NUM. */
644 struct mem_region *m;
647 if (!mem_region_list)
649 printf_unfiltered (_("No memory region number %d.\n"), num);
653 for (ix = 0; VEC_iterate (mem_region_s, mem_region_list, ix, m); ix++)
654 if (m->number == num)
659 printf_unfiltered (_("No memory region number %d.\n"), num);
663 VEC_ordered_remove (mem_region_s, mem_region_list, ix);
667 mem_delete_command (char *args, int from_tty)
670 struct get_number_or_range_state state;
672 require_user_regions (from_tty);
674 target_dcache_invalidate ();
676 if (args == NULL || *args == '\0')
678 if (query (_("Delete all memory regions? ")))
684 init_number_or_range (&state, args);
685 while (!state.finished)
687 num = get_number_or_range (&state);
695 dummy_cmd (char *args, int from_tty)
699 extern initialize_file_ftype _initialize_mem; /* -Wmissing-prototype */
701 static struct cmd_list_element *mem_set_cmdlist;
702 static struct cmd_list_element *mem_show_cmdlist;
705 _initialize_mem (void)
707 add_com ("mem", class_vars, mem_command, _("\
708 Define attributes for memory region or reset memory region handling to\n\
711 mem <lo addr> <hi addr> [<mode> <width> <cache>],\n\
712 where <mode> may be rw (read/write), ro (read-only) or wo (write-only),\n\
713 <width> may be 8, 16, 32, or 64, and\n\
714 <cache> may be cache or nocache"));
716 add_cmd ("mem", class_vars, mem_enable_command, _("\
717 Enable memory region.\n\
718 Arguments are the code numbers of the memory regions to enable.\n\
719 Usage: enable mem <code number>...\n\
720 Do \"info mem\" to see current list of code numbers."), &enablelist);
722 add_cmd ("mem", class_vars, mem_disable_command, _("\
723 Disable memory region.\n\
724 Arguments are the code numbers of the memory regions to disable.\n\
725 Usage: disable mem <code number>...\n\
726 Do \"info mem\" to see current list of code numbers."), &disablelist);
728 add_cmd ("mem", class_vars, mem_delete_command, _("\
729 Delete memory region.\n\
730 Arguments are the code numbers of the memory regions to delete.\n\
731 Usage: delete mem <code number>...\n\
732 Do \"info mem\" to see current list of code numbers."), &deletelist);
734 add_info ("mem", mem_info_command,
735 _("Memory region attributes"));
737 add_prefix_cmd ("mem", class_vars, dummy_cmd, _("\
738 Memory regions settings"),
739 &mem_set_cmdlist, "set mem ",
740 0/* allow-unknown */, &setlist);
741 add_prefix_cmd ("mem", class_vars, dummy_cmd, _("\
742 Memory regions settings"),
743 &mem_show_cmdlist, "show mem ",
744 0/* allow-unknown */, &showlist);
746 add_setshow_boolean_cmd ("inaccessible-by-default", no_class,
747 &inaccessible_by_default, _("\
748 Set handling of unknown memory regions."), _("\
749 Show handling of unknown memory regions."), _("\
750 If on, and some memory map is defined, debugger will emit errors on\n\
751 accesses to memory not defined in the memory map. If off, accesses to all\n\
752 memory addresses will be allowed."),
754 show_inaccessible_by_default,